Mercurial > games > semicongine

changeset 48:8305f8619a27

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add: some more instructions
author Sam <sam@basx.dev>
date Thu, 19 Jan 2023 00:47:12 +0700
parents 350d86c9abe8
children f70f7b3878e4
files README.md
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Thu Jan 19 00:43:47 2023 +0700
+++ b/README.md	Thu Jan 19 00:47:12 2023 +0700
@@ -6,6 +6,14 @@
 This is a very simplistic little game engine, mainly trying to wrap around vulkan and the operating system's windowing, input and audio system.
 This is using the last programming language you will ever need, [Nim](https://nim-lang.org/)
 
+Building
+--------
+
+Run ```nim help``` to see a list of available build commands.
+
+It is required to download the glslangValidator binary into the ```examples/``` directory in order to be able to build.
+There is a nim command for this that works on linux.
+
 Compilation on Windows
 ----------------------
 
@@ -16,6 +24,8 @@
 - Windows CRT SDK (some important header files)
 - Some version of MSVC (the compiler)
 
+glslangValidator cannot yet be downloaded automatically on windows, check config.nim for instructions.
+
 Roadmap
 -------