From 7efae1e68faaa744738349fcada8d131da9e46bd Mon Sep 17 00:00:00 2001
From: acdemiralp <demiralpali@gmail.com>
Date: Wed, 10 Feb 2021 00:01:12 +0100
Subject: [PATCH] Added readme, script adjustments for ease of use.

---
 batch.sh                                |  2 +-
 install.sh                              |  1 +
 readme.md                               | 13 +++++++++----
 run.sh                                  |  2 +-
 test_data/example.json => settings.json |  0
 5 files changed, 12 insertions(+), 6 deletions(-)
 rename test_data/example.json => settings.json (100%)

diff --git a/batch.sh b/batch.sh
index c2a9218..86cf435 100755
--- a/batch.sh
+++ b/batch.sh
@@ -10,4 +10,4 @@
 
 module load gcc/10
 
-/home/rwth0432/source/oxyflame_rendering_tools/offline_ray_tracer/build/offline_ray_tracer /hpcwork/rwth0432/data/oxyflame/settings.json
+./offline_ray_tracer/build/offline_ray_tracer ./settings.json
diff --git a/install.sh b/install.sh
index 17604cc..9ef6924 100755
--- a/install.sh
+++ b/install.sh
@@ -37,3 +37,4 @@ cd build
 export VTK_DIR=../../dependencies/VTK-9.0.1/build/lib64/cmake/vtk-9.0/
 ../../dependencies/cmake-3.19.4/bin/cmake ..
 ../../dependencies/cmake-3.19.4/bin/cmake --build . --clean-first --config Release --parallel 64
+cd ../..
\ No newline at end of file
diff --git a/readme.md b/readme.md
index 40a45a0..331dde3 100644
--- a/readme.md
+++ b/readme.md
@@ -1,7 +1,12 @@
 ## Oxyflame Rendering Tools
 
-### Installation
-Coming soon!
+## Dependencies
+- GCC 10+
 
-### Running
-Coming soon!
+## Installation
+- Run `install.sh` which downloads CMake, Ospray, VTK, and then builds the tools.
+
+## Running
+- Modify `settings.json` to locate the datasets and adjust camera path.
+- For interactive mode, run `run.sh`.
+- For batch mode, run `sbatch batch.sh`.
\ No newline at end of file
diff --git a/run.sh b/run.sh
index 8c70dc5..1bea4cc 100755
--- a/run.sh
+++ b/run.sh
@@ -2,4 +2,4 @@
 
 module load gcc/10
 
-./offline_ray_tracer/build/offline_ray_tracer /hpcwork/rwth0432/data/oxyflame/settings.json
+./offline_ray_tracer/build/offline_ray_tracer ./settings.json
diff --git a/test_data/example.json b/settings.json
similarity index 100%
rename from test_data/example.json
rename to settings.json
-- 
GitLab