diff --git a/README.md b/README.md index 0a18eea..0a82173 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,27 @@ ## Synopsis In a dystopian future, -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. +## Screenshots +@@@ ## Installation Download latest release, or browse releases page. @@@ +## Building from source + +Dependencies: +- Debian: `vulkan-tools libvulkan-dev vulkan-validationlayers-dev spirv-tools` +- Arch: `vulkan-devel` + +Check for vulkan compatibility +([vulkan-tutorial.com](https://vulkan-tutorial.com/resources/vulkan_tutorial_en.pdf)): +_"If installation was successful, you should be all set with +the Vulkan portion. Remember to run vkcube, and ensure you +see a pop up a window with a spinning cube. If you receive +an error message then ensure that your drivers are up-to-date, +include the Vulkan runtime and that your graphics card is +supported"_ + ## Support @@@ @@ -26,11 +41,11 @@ Download latest release, or browse releases page. @@@ ### Story -- [ ] Setting (where, when) -- [ ] Characters (who) -- [ ] Conflict (why) +- [ ] [Setting](./doc/story/setting.md) (where, when) +- [ ] [Characters](./doc/story/characters.md) (who) +- [ ] [Conflict](./doc/story/plot.md) (why) - [ ] [Plot](./doc/story/plot.md) (how) -- [ ] Theme (goal) +- [ ] [Theme](./doc/story/plot.md) (goal) ## Contributing @@@