Create README.md

Detailed README for repository

Author: jasonlmfong

README.md

@@ -0,0 +1,102 @@
+# Model-Modifier
+[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/jasonlmfong/Model-Modifier/blob/main/LICENSE)
+
+This repository contains my `C++17` and `OpenGL` implementation of a mesh viewer for `.obj` files, with various algorithms for interacting with the meshes.
+
+## Features
+- [x] Dynamic object selection
+    - [x] Simple geometric objects
+    - [x] Complex test objects
+    - [x] Caching
+- [x] Mesh modification algorithms
+    - [x] Subdivision surface
+        - [x] [Catmull-Clark](https://en.wikipedia.org/wiki/Catmull%E2%80%93Clark_subdivision_surface)
+        - [x] [Doo-Sabin](https://en.wikipedia.org/wiki/Doo%E2%80%93Sabin_subdivision_surface)
+        - [x] [Loop](https://en.wikipedia.org/wiki/Loop_subdivision_surface)
+    - [ ] Simplification surface
+        - [ ] [QEM](https://www.cs.cmu.edu/~./garland/Papers/quadrics.pdf)
+- [x] Shading options
+    - [x] Flat shading (Per-face normals)
+    - [x] Smooth shading (Per-vertex normals)
+    - [x] Mixed shading (Per-Corner normals)
+- [x] Shader options
+    - [x] Normal shader
+    - [x] [Gourand shader](https://en.wikipedia.org/wiki/Gouraud_shading)
+    - [x] [Phong shader](https://en.wikipedia.org/wiki/Phong_shading)
+    - [x] Material controls
+        - [x] Ambient
+        - [x] Diffuse
+        - [x] Specular
+        - [x] Shine
+    - [x] Lighting controls
+        - [x] Position
+        - [x] Color
+    - [x] Multiple lights
+- [x] Render modes
+    - [x] Mesh polygons
+    - [x] Wireframe
+    - [x] Point cloud
+- [x] Information
+    - [x] Framerate counter
+    - [x] Number of triangles in current mesh
+- [x] Screenshot to PNG
+
+## Image Gallery
+![Sample armadillo rendering](Model-Modifier/gallery/Screenshot_2023-7-9_214740.png)
+> Armadillo mesh, Phong shader, 3 lights from different positions, not smoothened
+
+![Sample cow rendering 1](Model-Modifier/gallery/Screenshot_2023-9-11_12505.png)
+> Cow mesh, Normal shader, not smoothened
+
+![Sample cow rendering 2](Model-Modifier/gallery/Screenshot_2023-9-11_125011.png)
+> Cow mesh, Normal shader, smoothened 1 time with Catmull-Clark subdivision
+
+![Sample cow rendering 3](Model-Modifier/gallery/Screenshot_2023-9-11_125016.png)
+> Cow mesh, Normal shader, smoothened 1 time with Doo-Sabin subdivision
+
+![Sample cow rendering 4](Model-Modifier/gallery/Screenshot_2023-9-11_125020.png)
+> Cow mesh, Normal shader, smoothened 1 time with Loop subdivision
+
+![Sample smoothed star rendering](Model-Modifier/gallery/Screenshot_2023-7-16_141825.png)
+> Star mesh, Phong shader, 3 lights from different positions, smoothened many times with mixed subdivision
+
+## Dependencies
+- `GLFW`
+- `GLM`
+- `Dear ImGui`
+
+## List of 3D Models Used
+Here I try to list all sources wherever possible.
+
+### Geometric models
+| Model Name | Source |
+|------------|--------|
+| Crumpled | [Keenan Crane](https://www.cs.cmu.edu/~kmcrane/Projects/ModelRepository/) |
+| Cube | Me |
+| Double Torus | [Geometry Collective](https://github.com/GeometryCollective/ddg-exercises/tree/main/input) |
+| Fandisk | CAD part Pratt & Whitney/Hughes Hoppe |
+| Icosahedron | Me |
+| Octahedron | Me |
+| Oloid | [Keenan Crane](https://www.cs.cmu.edu/~kmcrane/Projects/ModelRepository/) |
+| Sphere | [Geometry Collective](https://github.com/GeometryCollective/ddg-exercises/tree/main/input) |
+| Star | Unknown |
+| T-shape | Me |
+| Torus | [Geometry Collective](https://github.com/GeometryCollective/ddg-exercises/tree/main/input) |
+| Tubes | Me |
+
+### Test models
+| Model Name | Source |
+|------------|--------|
+| Ankylosaurus | Unknown |
+| Armadillo | [Stanford](http://graphics.stanford.edu/data/3Dscanrep/) | 
+| Bob | [Keenan Crane](https://www.cs.cmu.edu/~kmcrane/Projects/ModelRepository/) |
+| Bunny | [Stanford](http://graphics.stanford.edu/data/3Dscanrep/) |
+| Cow |  [Viewpoint Animation Engineering / Sun Microsystems](https://gfx.cs.princeton.edu/proj/sugcon/models/) |
+| Cow head | [Geometry Collective](https://github.com/GeometryCollective/ddg-exercises/tree/main/input) |
+| Face | [Geometry Collective](https://github.com/GeometryCollective/ddg-exercises/tree/main/input) |
+| Gargoyle | [Geometry Collective](https://github.com/GeometryCollective/ddg-exercises/tree/main/input) |
+| Kitten | [Geometry Collective](https://github.com/GeometryCollective/ddg-exercises/tree/main/input) |
+| Shuttle | Unknown |
+| Suzanne | [Blender](https://www.blender.org/) |
+| Teapot | [Martin Newell](https://users.cs.utah.edu/~dejohnso/models/teapot.html) | 
+| Teddy | Unknown |