about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/README.md33
-rw-r--r--src/python/README.md9
2 files changed, 11 insertions, 31 deletions
diff --git a/src/README.md b/src/README.md
index fa161c8..3f6a037 100644
--- a/src/README.md
+++ b/src/README.md
@@ -1,32 +1,3 @@
-# README
+# Source Directory
 
-| Name                | Value                 |
-| ---                 | ---                   |
-| Time (hour min sec) | 1:30:45               |              
-| Number of Stars     | 1000                  |               
-| Stars Kicked:       | 327718674             |            
-| Percent:            | 0.000305139767531221% |
-
-### 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>
+This Directory contains all the code used in the Project.
diff --git a/src/python/README.md b/src/python/README.md
new file mode 100644
index 0000000..3b96f7c
--- /dev/null
+++ b/src/python/README.md
@@ -0,0 +1,9 @@
+# Python Source Code
+
+### Step 1: Generating a lookuptable
+
+[insert image]
+
+### Step 2: Generate the Coordinates
+
+[insert image]