Added readme, script adjustments for ease of use.

7efae1e6 · Ali Can Demiralp · 47d927b9 · 7efae1e6 · 7efae1e6 · 7efae1e6
Commit 7efae1e6 authored Feb 9, 2021 by Ali Can Demiralp
--- 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
--- 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
--- a/readme.md
+++ b/readme.md
 ## Oxyflame Rendering Tools
-### Installation
+## Dependencies
-Coming soon!
+- GCC 10+
-### Running
+## Installation
-Coming soon!
+- 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
--- 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
--- a/test_data/example.json
+++ b/test_data/example.json