diff --git a/README.md b/README.md index 086b75aac238dfa710b3c2d780d9539abc815434..e02b5e577f19da3a9e1705c110d46d9e8b44f13c 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,31 @@ # WebGL-Raycaster -This raycaster is the result from my Bachelor's thesis. +This simple raycaster is the result from my Bachelor's thesis. It uses the webgl API for viewing volume data inside your browser. ## Getting Started - +To use this raycaster just clone the project on your local machine. It contains all necessary files +for viewing the example data. ### Prerequisites -No installation needed. Just a Browser which supports WebGL Version 2.0 +No installation needed. Just a browser which supports WebGL Version 2.0 + +## Running the raycaster + +Execute the [serve.bat](bin\serve.bat) file in your command line interface. This will start the HTTP-Server for delivering +the differen shaders and volume data. When the server is up and running, just browse to your localhost to start using the app. + +## Adding new files + +At the moment there is no interface for including own volume data. To add new files you have to adjust some of the files. +1. Copy the new volume data into the raycaster\raw folder. +2. Add the new volume data to the store inside the [main.js](raycaster\main.js) with all the necessary values. +3. Configure the dropdown menu inside the [index.html](raycaster\index.html) file with the new data. +4. Depending on the type of volume data, you must alter the texture values inside the [raycaster.js](raycaster\src\webGL\raycaster.js) file. +When done correctly you should be able to view the new dataset. ## License