Merge pull request #2 from HanEmile/nstars

Nstars

1 files changed, 25 insertions, 0 deletions

diff --git a/src/README.md b/src/README.md
new file mode 100644
index 0000000..a22aa75
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,25 @@
+# README
+
+### workflow:
+
+---
+
+#### Generate the lookuptable
+
+
+    $ ./lookup.py <number of values> <filename>
+
+- the __number of values__ can be given using the scientific notaion e.g. 1e7.
+- the __filename__ should not overlap with any existing filename
+
+---
+
+#### Generate the coordinates
+
+
+    $ ./coord.py <number of stars> <save_to_file_location>
+
+
+#### Display the stars using Blender
+
+    $ blender --python view.py <star_coordinates_file>