added example

Author: mgeplf

README.rst

@@ -21,10 +21,25 @@ Once Ultraliser_ is installed, run the following ``bash`` commands:
 
 .. code-block:: bash
 
-    git clone https://github.com/BlueBrain/atlas-placement-hints
-    cd atlas-placement-hints
-    pip install -e .
+    pip install atlas-placement-hints
+
+Examples
+========
+
+To generate the placement hints datasets for the isocortex, one can do the following:
+
+Note that the required datasets under `data/*` can be generated by following the example in `atlas-splitter`_.
+
+Also note, depending on the resolution of the volume, this may require significant amounts of available RAM).
+
+.. code-block:: bash
 
+   atlas-placement-hints isocortex                              \
+     --hierarchy-path data/ccfv3/split_hierarcy.json            \
+     --annotation-path data/ccfv3/split_annotations.nrrd        \
+     --direction-vectors-path data/ccfv3/direction_vectors.nrrd \
+     --algorithm voxel-based                                    \
+     --output-dir data/
 
 Instructions for developers
 ===========================
@@ -39,8 +54,6 @@ Run the following commands before submitting your code for review:
 
 These formatting operations will help you pass the linting check `testenv:lint` defined in `tox.ini`.
 
-.. _Ultraliser: https://github.com/BlueBrain/Ultraliser
-
 Acknowledgements
 ================
 
@@ -49,3 +62,7 @@ The development of this software was supported by funding to the Blue Brain Proj
 For license and authors, see LICENSE.txt and AUTHORS.txt respectively.
 
 Copyright © 2022 Blue Brain Project/EPFL
+
+.. _Ultraliser: https://github.com/BlueBrain/Ultraliser
+.. _`atlas-splitter`: https://github.com/BlueBrain/atlas-splitter
+