diff --git a/README.md b/README.md index 2c564be..b7253c8 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,15 @@ Useful links: **Simplified build using make** ```bash -make #build c extension inplace +$ make #build c extension inplace +``` + +``` +$ make help +clean Remove the build folder and the shared library +debug Build extension with debug prints and assertions +ext [DEFAULT] build c extension in place +test Run unit tests using pytest ``` **Manual build** @@ -19,19 +27,19 @@ make #build c extension inplace #build in place and use from the same folder #sometimes necessary to remove build folder and .so #by hand -python setup.py build_ext --inplace - - +$ python setup.py build_ext --inplace ``` + + To use make sure that the .so and potentially python files are in PYTHONPATH (or installed in developer mode) ```bash #conda -conda develop install . +$ conda develop install . #or with pip -pip install --editable . +$ pip install --editable . ``` ## Cluster file specifications