Added readme, script adjustments for ease of use.

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

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

readme.md

 ## 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

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