first commit

Author: evandempsey

.gitignore

@@ -34,3 +34,7 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+ 
+#Pycharm
+.idea
+

README.md

@@ -1,4 +1,17 @@
 software-renderer
 =================
 
-A simple 3D renderer in Python
+A simple 3D renderer written using Python and Pygame.
+
+Pass the .obj file as an argument to renderer.py, e.g.
+python renderer.py models/teapot.obj
+
+F toggles wireframe or solid mesh
+R toggles rotation
+B resets the camera to the original position
+
+Use the mouse wheel to zoom in and out.
+Left-click and drag vertically or horizontally to control pitch and yaw.
+Right-click and drag horizontally to control roll.
+
+The framerate is displayed in the top left corner.