Commit 22d44836 authored by Alexandra's avatar Alexandra

readme change

parent a6e13c59
......@@ -12,15 +12,17 @@ Our results and a quick analysis can be found here :
You can easily verify the results for yourself. Just follow these instructions :
## Prerequisites
All tests were built using [nodejs](https://nodejs.org/en/) (please follow the instructions given on the nodejs website to install).
All tests were built using [nodejs](https://nodejs.org/en/) (please follow the instructions given on the nodejs website to install) and [puppeteer](https://developers.google.com/web/tools/puppeteer) (init using `node install puppeteer`).
## Downloading
Simply clone this git, all necessary files (including nodejs modules) should be downloaded automatically.
## Running
* Executing all tests : for each milestone, launch Milestone[X]/all.js (May take a long time !)
* Executing a specific bench : launch Milestone1/bench_files/your_bench.js
* Executing a specific test : launch Milestone[X]/unit_tests/your_test.js with corresponding arguments
* Executing all tests : for each milestone, launch Milestone[X]/run.js (May take a long time !)
* Executing a specific test on all available files: launch run.js with `-o test_name`
* Executing a specific test on a specific file: launch run.js with `-o test_name -f file_path`
* A verbose option is available (`-v`) to log all server message to the nodejs console. This is a good way to monitor what's happening with the tests.
* The config file (Milestone[X]/config.json) is human-readable to allow for easy changes in case you want to modify the result files path or the Mynij instance link.
## Adding test cases/files
Add your file to the corresponding folder in Milestone[X]/files and the bench should test it automatically.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment