NonrecursiveHEADmaster

1 files changed, 68 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..75bc509
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
+# QUICK_SORT
+
+## HowTos
+
+***The build system is using CMake***
+
+### Setup CMake
+
+1. `cd <SOURCE_DIR>`
+2. `mkdir build`
+3. `cd build`
+4. `cmake ..`
+
+### Build
+
+After CMake is setup, type:
+
+* `make`
+
+### Test all
+
+* `make test-all`
+
+Example output: i5-7200U, Archlinux, linux 4.9.2, gcc 6.3.1
+~~~
+100000 Int for 100 Iterations
+Average time taken for me  (s): 0.00987307
+Average time taken for std (s): 0.0111078
+Speedup over std : 1.12506
+Median time taken for me  (s): 0.0098605
+Median time taken for std (s): 0.0110835
+Speedup over std : 1.12403
+100000 Long for 100 Iterations
+Average time taken for me  (s): 0.0100124
+Average time taken for std (s): 0.0111518
+Speedup over std : 1.1138
+Median time taken for me  (s): 0.009971
+Median time taken for std (s): 0.011114
+Speedup over std : 1.11463
+100000 Float for 100 Iterations
+Average time taken for me  (s): 0.0107144
+Average time taken for std (s): 0.0111841
+Speedup over std : 1.04384
+Median time taken for me  (s): 0.0106765
+Median time taken for std (s): 0.011099
+Speedup over std : 1.03957
+100000 Double for 100 Iterations
+Average time taken for me  (s): 0.0108789
+Average time taken for std (s): 0.0115306
+Speedup over std : 1.05991
+Median time taken for me  (s): 0.010835
+Median time taken for std (s): 0.0114525
+Speedup over std : 1.05699
+~~~
+
+### Individual tests
+
+See `./qsort` and follow the instructions, for examples:
+
+* Sort *10000* **int** items for *10000* iterations:
+~~~
+./qsort i 10000 10000
+~~~
+* Sort *10000* **float** items for *10000* iterations:
+~~~
+./qsort f 10000 10000
+~~~
+