Yandrik/term-render
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: added readme

Browse Source
This commit is contained in:
Yandrik 2022-12-30 18:09:15 +01:00
parent 1e6b6fcec6
commit 9b85f4ae4e
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# Terminal Renderer
This is a program to render 3D objects to the terminal.
It was created for educational use, and is therefore **not production code.** Keep this in mind.
### Functionality
This program renders hard-coded shapes to the terminal.
The angle at which this happens can be controlled by using the `W, A, S, D, Q` and `E` keys.
To quit the application, use the `q`, `ESC` or `BACKSPACE` keys.
### Building
Clone the repository, and run `cargo run` inside of the folder.