Fix documentation

This commit is contained in:
2019-10-23 10:39:08 +02:00
parent c4b2bd2fe2
commit 136e5b42b6

View File

@@ -27,7 +27,7 @@ This enables the index implementations to be agnostic from the underlying data s
* Clone the workspace, which will take care of bringing all the repositories needed. * Clone the workspace, which will take care of bringing all the repositories needed.
```sh ```sh
git clone --recurse git@gitlab.epfl.ch:DIAS/PROJECTS/HBP-SP5/mercator.git git clone --recurse <repository URI>
``` ```
The following steps assume the working directory is the root of the mercator repository. The following steps assume the working directory is the root of the mercator repository.
@@ -45,11 +45,11 @@ This enables the index implementations to be agnostic from the underlying data s
cd mercator_indexer cd mercator_indexer
for f in ../mercator_data_generator/1*.json for f in ../mercator_data_generator/1*.json
do do
ln -s $f ln -s $f
done done
cargo run --release -- 1k 10k 100k cargo run --release -- 1k 10k 100k
``` ```
* Run the Spatial Index, while providing the path to the datasets. * Run the Spatial Index, while providing the path to the datasets.
```sh ```sh
@@ -62,7 +62,7 @@ This enables the index implementations to be agnostic from the underlying data s
## Documentation ## Documentation
For more information, please refer to the [documentation](https://epfl-dias.github.io/PROJECT_NAME/). For more information, please refer to the [documentation](https://epfl-dias.github.io/mercator/).
If you want to build the documentation and access it locally, you can use: If you want to build the documentation and access it locally, you can use: