doc to compile project

doc/README.md

@@ -0,0 +1,7 @@
+# Documentation
+
+### Links
+
+- [Download datasets](download-datasets.md)
+- [Compile the project](compile-project.md)
+- [Run speedup analysis notebooks](./speedup_analysis)

doc/compile-project.md

@@ -0,0 +1,55 @@
+| Executables | Description                           |  
+|:------------|:--------------------------------------|
+| `bwtzip`    | Original sequential version of bwtzip |
+| `bwtunzip`  | Decompressor                          |
+| `pbwtzip`   | Parallel version (3-stage pipeline)   |
+| `pbwtzip2`  | Parallel version (2-stage pipeline)   |
+| `tests`     | Test to check pbwtzip and pbwtzip2    |
+
+
+# Compile project
+
+## Debug build
+
+Fast way:
+
+```bash
+$ chmod +x ./script/*
+
+$ ./script/build_debug.sh
+```
+
+Manually:
+
+```bash
+$ mkdir cmake-build-debug
+
+$ cd cmake-build-debug
+
+$ cmake -DCMAKE_BUILD_TYPE=Debug ..
+
+$ make -j4
+```
+
+## Release build
+
+Fast way:
+
+```bash
+$ chmod +x ./script/*
+
+$ ./script/build_release.sh
+```
+
+Manually:
+
+```bash
+$ mkdir cmake-build-release
+
+$ cd cmake-build-release
+
+$ cmake -DCMAKE_BUILD_TYPE=Release ..
+
+$ make -j4
+```
+

doc/speedup_analysis/README.md

@@ -0,0 +1,46 @@
+# Speedup analysis of pbwtzip and pbwtzip2
+
+- [pbwtzip_speedup_analysis.ipynb](./pbwtzip_speedup_analysis.ipynb)
+- [pbwtzip2_speedup_analysis.ipynb](./pbwtzip2_speedup_analysis.ipynb)
+
+
+## Run the notebooks
+
+1.  Install Python virtualenv
+
+```bash
+$ pip install virtualenv
+```
+
+2. Create a new virtual env inside the doc/speedup_analysis folder
+
+```bash
+$ cd doc/speedup_analysis
+$ python3 -m venv ./venv
+```
+
+3.  Install Python dependencies
+
+```bash
+# activate virtual env
+$ source venv/bin/activate
+
+# first upgrade pip
+(venv) $ pip install --upgrade pip
+
+(venv) $ pip install --upgrade -r requirements.txt
+
+# deactivate virtual env
+$ deactivate
+```
+
+
+4. Activate virtualenv and run Jupiter Notebook
+
+```bash
+$ source venv/bin/activate
+
+(venv) $ jupyter notebook .
+```
+
+A new page on your browser should open with Jupyter running.