init
This commit is contained in:
parent
e95b0753b4
commit
947bd5bcb8
1 changed files with 21 additions and 6 deletions
27
README.md
27
README.md
|
@ -3,12 +3,27 @@
|
||||||
## Synopsis
|
## Synopsis
|
||||||
In a dystopian future,
|
In a dystopian future,
|
||||||
|
|
||||||
## Visuals
|
## Screenshots
|
||||||
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.
|
@@@
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
Download latest release, or browse releases page. @@@
|
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
|
## Support
|
||||||
@@@
|
@@@
|
||||||
|
|
||||||
|
@ -26,11 +41,11 @@ Download latest release, or browse releases page. @@@
|
||||||
|
|
||||||
### Story
|
### Story
|
||||||
|
|
||||||
- [ ] Setting (where, when)
|
- [ ] [Setting](./doc/story/setting.md) (where, when)
|
||||||
- [ ] Characters (who)
|
- [ ] [Characters](./doc/story/characters.md) (who)
|
||||||
- [ ] Conflict (why)
|
- [ ] [Conflict](./doc/story/plot.md) (why)
|
||||||
- [ ] [Plot](./doc/story/plot.md) (how)
|
- [ ] [Plot](./doc/story/plot.md) (how)
|
||||||
- [ ] Theme (goal)
|
- [ ] [Theme](./doc/story/plot.md) (goal)
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
@@@
|
@@@
|
||||||
|
|
Loading…
Reference in a new issue