Commit a444a771 authored by Alexandra Rogova's avatar Alexandra Rogova

added readme

parent adb78155
# Mynij Unit Tests
Unit tests to determine the time and cost of running [Mynij](https://lab.nexedi.com/ARogova/Mynij). The results and a quick analysis can be found [here](https://alpha.iodide.io/notebooks/3633/?viewMode=report).
# Run your own tests
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).
## Downloading
Simply clone this git, all necessary files (including nodejs modules) should be downloaded automatically.
## Running
You can now run the tests. Simply launch the selected file using nodejs.
# There are a lot of files here, what's going on?
* __node_modules__: folder automatically created by nodejs and where all the modules live
* __results__: folder with all the test results as CSV files
* __test_files__: the tests require a large amount of tests files which are all in this folder, separated by category (CSV files, RSS feeds, XML sitemaps, ...)
* __something_something_bench.js__: these are the files that launch the actual tests and record the information to create the result files
* __everything else__: actual test files! If launched separately, require arguments (look at the corresponding bench to see examples of use)
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