diff options
Diffstat (limited to 'exampleData/headlessRuns/README.md')
| -rw-r--r-- | exampleData/headlessRuns/README.md | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/exampleData/headlessRuns/README.md b/exampleData/headlessRuns/README.md index 61ef522..6f2b926 100644 --- a/exampleData/headlessRuns/README.md +++ b/exampleData/headlessRuns/README.md @@ -1,21 +1,29 @@ # Example Headless Run Configurations # -Use the included script `runExamples.sh` to use the headless run system +Use the included script `<FiveUI>/bin/runHeadless.sh` to use the headless run system included with FiveUI. You will probably need to change the values of the environment variables at the top of the script to match your local environment. ## Usage ## -usage: runExample.sh <input file 1> [<input file 2> ...] - -h print this help message - -o <outfile> write output to file - -r <report directory> write HTML reports to given directory - -v verbose output - -vv VERY verbose output +To use the headless application, invoke `runHeadless.sh` from the command line: + + usage: runHeadless.sh <input file 1> [<input file 2> ...] + -h print this help message + -o <outfile> write output to file + -r <report directory> write HTML reports to given directory + -v verbose output + -vv VERY verbose output ## Notes ## -NB - The examples run configuration files in this directory require a -local websever to be running on port 8000 hosting the HTML files in +Some of the example run configuration files in this directory require a +local web server to be running on port 8000 hosting the HTML files in $FIVEUI_ROOT/exampleData/sites/. + +If you have Python installed on your system, an easy way to get a local web server +running for testing purposes is: + + cd $FIVEUI_ROOT/exampleData/sites/ + python -m SimpleHTTPServer |