doc: added readme
This commit is contained in:
		
							
								
								
									
										18
									
								
								README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								README.md
									
									
									
									
									
										Normal 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.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Reference in New Issue
	
	Block a user