From 9b85f4ae4ea2cef0a5f32de3df0af01d8c61511d Mon Sep 17 00:00:00 2001 From: Yandrik Date: Fri, 30 Dec 2022 18:09:15 +0100 Subject: [PATCH] doc: added readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a9f0f7a --- /dev/null +++ b/README.md @@ -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. + +