1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..738c5ac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Calculate optical design for laser triangulation scanner
+
+This app allows to enter parameters of your lense, image sensor and scanner body and visualize resulting optical schema
+
+# Build and run
+
+```sh
+git clone https://git.kostovsky.me/optical_design/
+cd optical_design/
+git submodule update --init
+mkdir build
+cd build/
+cmake ..
+make -j${nproc}
+./src/optical_design
+```