From 4e0db18d64477035c5d1bdbec25e1ffbb7622b4c Mon Sep 17 00:00:00 2001
From: Frank Imhof <imhof.frank@gmail.com>
Date: Mon, 2 Nov 2020 20:11:40 +0100
Subject: [PATCH] more details added to README.md

---
 README.md                 | 30 +++++++++++++++++++-----------
 src/testresults/README.md | 18 ++++++++++++++----
 2 files changed, 33 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index f20215f..a50283a 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,37 @@
-# Visualization of testresults (oqs-speed and pq-tls-benchmark)
-Testscripts were run on a computer with the following specs:
+# Visualization of KEX- and SIG-Algorithm performance
+This app visualizes results from the following performance tests:
+- [oqs-speed](https://github.com/open-quantum-safe/speed/tree/main/perf/scripts) handshakes.py
+- [pq-tls-benchmark emulation-exp](https://github.com/xvzcf/pq-tls-benchmark/tree/master/emulation-exp/code/kex) experiment.py
 
+The tests were run on a computer with the following specs:\
 **iMac**: (mid 2010)\
 **Processor**: 2.8 GHz Intel Core i5\
 **Memory**: 16 GB 1333 MHz DDR3\
 
-# Run with docker
-## Clone the repository
+## Run with docker
+#### Clone the repository
  `git clone https://github.com/frankimhof/speed-viz-app.git`\
  `cd viz-speed-app`
-## Build the docker image
+#### Build the docker image
  `docker build -t viz-speed-app .`
-## Run the docker image
+#### Run the container
  `docker run -p 80:80 viz-speed-app`
-## Open the browser and visit
+#### Open the browser and visit
  `localhost:80`
 
-# Run with node
-## Clone the repository
+## Run with node
+#### Clone the repository
 `git clone https://github.com/frankimhof/speed-viz-app.git`\
 `cd viz-speed-app`
-## Install dependencies
+#### Install dependencies
 `npm install`
-## Run
+#### Run
 `npm start`\
 This will start the app on `localhost:3000`
 
+## Visualize your own testresults
+To visualize your own testresults, see [here](https://github.com/frankimhof/speed-viz-app/blob/main/src/testresults/README.md) for instructions on how to prepare the data.
+</br>
+</br>
+</br>
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
diff --git a/src/testresults/README.md b/src/testresults/README.md
index c7c2fa7..dedee74 100644
--- a/src/testresults/README.md
+++ b/src/testresults/README.md
@@ -1,5 +1,15 @@
-# Generating the JSON Files
-Run [pq-tls-benchmark emulation-exp](https://github.com/xvzcf/pq-tls-benchmark/tree/master/emulation-exp/code/kex) kex tests.\
-Put all the resulting `.csv` files into this directory and run\
-`node convert.js`\
+# Visualize your own testresults
+## Run the tests
+Run [oqs-speed](https://github.com/open-quantum-safe/speed/tree/main/perf/scripts) handshakes.py
+Run [pq-tls-benchmark emulation-exp](https://github.com/xvzcf/pq-tls-benchmark/tree/master/emulation-exp/code/kex) experiment.py
+## Moving files
+Put all the results (`.csv` files and `handshakes.json` file) into this directory.
+
+## Generating JSON files from .csv
+run `node convert.js`\
 This will read all the `.csv` Files, extract **median** and **95 percentile** values, sort the data by round trip time, and store it in 4 different `.json` Files.
+
+## Restart
+For the app to display the newly added data, you either have to
+- build a new docker image or
+- stop and rerun `npm start` from within project root directory