Mercurial > games > semicongine
comparison README.md @ 922:9d30ec7fb91e
add: some notes
| author | sam <sam@basx.dev> |
|---|---|
| date | Thu, 21 Mar 2024 15:46:53 +0700 |
| parents | 677f3b5a2943 |
| children | 27fdf971354d |
comparison
equal
deleted
inserted
replaced
| 921:c3b54db484fb | 922:9d30ec7fb91e |
|---|---|
| 1 Note: If you are reading this on Github, please not that this is only a mirror | |
| 2 repository and the most recent changes or on the ```hg``` branch. | |
| 3 | |
| 4 Also, some of the README is a bit out of date, as I am now focusing mostly on | |
| 5 writing my first game. However, developement ist onging and the documentation | |
| 6 will be overhauled once I start working on my next game. | |
| 7 | |
| 1 # Semicongine | 8 # Semicongine |
| 2 | 9 |
| 3 Hi there | 10 Hi there |
| 4 | 11 |
| 5 This is a little game engine, mainly trying to wrap around vulkan and the | 12 This is a little game engine, mainly trying to wrap around vulkan and the |
| 6 operating system's windowing, input and audio system. I am using the last | 13 operating system's windowing, input and audio system. I am using the last |
| 7 programming language you will ever need, [Nim](https://nim-lang.org/) | 14 programming language you will ever need, [Nim](https://nim-lang.org/) |
| 8 | |
| 9 ## Building | |
| 10 | |
| 11 Requires Nim to be installed and `glslangValidator` to be downloaded to the | |
| 12 directory of the main compilation file (e.g. into `examples/` in order to | |
| 13 compile the examples). It can be downloaded at | |
| 14 https://github.com/KhronosGroup/glslang/releases/. | |
| 15 | |
| 16 Run `nim help` to see a list of available build commands. | |
| 17 | 15 |
| 18 ## Roadmap | 16 ## Roadmap |
| 19 | 17 |
| 20 Here a bit to see what has been planed and what is done already. Is being | 18 Here a bit to see what has been planed and what is done already. Is being |
| 21 updated frequently (marking those checkboxes just feels to good to stop working). | 19 updated frequently (marking those checkboxes just feels to good to stop working). |
