term-render/README.md

21 lines
531 B
Markdown
Raw Permalink Normal View History

2022-12-30 18:09:15 +01:00
# 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.
2022-12-30 18:10:46 +01:00
![tie-fighter mesh](./screenshot.png)
2022-12-30 18:09:15 +01:00
### 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.
2022-12-30 18:24:03 +01:00
To quit the application, use the `c`, `ESC` or `BACKSPACE` keys.
2022-12-30 18:09:15 +01:00
### Building
Clone the repository, and run `cargo run` inside of the folder.