Updated README.md with build instructions
[hair] / README.md
index 388643d..24bbc43 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,4 +3,30 @@ Mohawk hair simulation
 
 Hair simulation.
 
+Demo:
+https://www.youtube.com/watch?v=MfrZ_0EJvXk
 
+Build Instructions
+------------------
+Prerequisites:
+
+Build gph-math following the instructions here:
+https://github.com/jtsiomb/gph-math/
+
+and libimago following the instructions here:
+https://github.com/jtsiomb/libimago
+
+Then in the program directory run:
+
+$ make
+
+$ ./hair
+
+License
+-------
+Copyright (C) 2019 Eleni Maria Stea <elene.mst@gmail.com>
+
+This program is free software. You are free to use, modify, and/or re-distribute
+it, under the terms of the GNU General Public License version 3, or at your
+option any later version published by the Free Software Foundation. See COPYING
+for details.