comparison README.md @ 48:8305f8619a27

add: some more instructions
author Sam <sam@basx.dev>
date Thu, 19 Jan 2023 00:47:12 +0700
parents 2378ada1a14e
children 547f3a374271
comparison
equal deleted inserted replaced
47:350d86c9abe8 48:8305f8619a27
3 3
4 Hi there 4 Hi there
5 5
6 This is a very simplistic little game engine, mainly trying to wrap around vulkan and the operating system's windowing, input and audio system. 6 This is a very simplistic little game engine, mainly trying to wrap around vulkan and the operating system's windowing, input and audio system.
7 This is using the last programming language you will ever need, [Nim](https://nim-lang.org/) 7 This is using the last programming language you will ever need, [Nim](https://nim-lang.org/)
8
9 Building
10 --------
11
12 Run ```nim help``` to see a list of available build commands.
13
14 It is required to download the glslangValidator binary into the ```examples/``` directory in order to be able to build.
15 There is a nim command for this that works on linux.
8 16
9 Compilation on Windows 17 Compilation on Windows
10 ---------------------- 18 ----------------------
11 19
12 Requires a Windows SDK to be installed (e.g. via Visual Studio Build Tools). 20 Requires a Windows SDK to be installed (e.g. via Visual Studio Build Tools).
13 Also, using Nim on Windows with mingw seems to be way faster than with vcc/lc. 21 Also, using Nim on Windows with mingw seems to be way faster than with vcc/lc.
14 For compilation with vcc/ls, install additionaly (with Visual Studio Build Tools): 22 For compilation with vcc/ls, install additionaly (with Visual Studio Build Tools):
15 - Windows Universal C Runtime (some important files) 23 - Windows Universal C Runtime (some important files)
16 - Windows CRT SDK (some important header files) 24 - Windows CRT SDK (some important header files)
17 - Some version of MSVC (the compiler) 25 - Some version of MSVC (the compiler)
26
27 glslangValidator cannot yet be downloaded automatically on windows, check config.nim for instructions.
18 28
19 Roadmap 29 Roadmap
20 ------- 30 -------
21 31
22 Still tons to do, but it feels like the worst things (except audio maybe?) are over the hill. 32 Still tons to do, but it feels like the worst things (except audio maybe?) are over the hill.