diff --git a/README_SETUP.md b/README_SETUP.md index 50bd611cd83ad6d7c8b13239e67e4d117455bca9..f024a9f4ced9aae6cfb134c666c587f3b18b21bf 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -1,21 +1,27 @@ -# Structure +# Folder Structure * The `src` folder contains all source code for the webinterface. * The `libs` folder contains all necessary third-party libraries as zip files. * The `test` folder contains the unittests for the webinterface. -* The `ext` folder contains extension for the webinterface. The make file will copy all javascript files from `ext/js/` into the public folder and links the javascript in the `public/xsl/main.xsl`. -* The `misc` folder contains a simple http server which is used for running the unit tests. +* The `ext` folder contains extension for the webinterface. The make file will + copy all javascript files from `ext/js/` into the public folder and links the + javascript in the `public/xsl/main.xsl`. +* The `misc` folder contains a simple http server which is used for running the + unit tests. # Setup -* run `make install` to compile/copy the webinterface to a newly created `public` folder. +* Run `make install` to compile/copy the webinterface to a newly created + `public` folder. # Test -* run `make test` to compile/copy the webinterface and the tests to a newly created `public` folder. -* run `make run-test-server` to start a python http server. -* The test suite can be started with `firefox http://localhost:8000/webinterface/` +* Run `make test` to compile/copy the webinterface and the tests to a newly + created `public` folder. +* Run `make run-test-server` to start a python http server. +* The test suite can be started with `firefox + http://localhost:8000/webinterface/` # Clean -* run `make clean` to clean up everything. +* Run `make clean` to clean up everything.