From 4fc2a05f635c387a7461197d8713708874c04086 Mon Sep 17 00:00:00 2001 From: Chris Hold Date: Mon, 5 Feb 2024 18:44:06 +0200 Subject: [PATCH] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e0168b3..4d36f4a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ So far, there are a bunch of functions exposed, please feel free to add/contribute more if needed! -Quickstart +Install --- 1. Clone SAFpy, SAF is provided as a submodule, and change to the folder @@ -24,7 +24,7 @@ For example with 4. Now we need to build *safpy*, which creates the module. Running (in the environment you want to use) -```pip install -e .```, +```pip install -e .``` with `.` in the SAFpy folder, builds it automatically and installs any potentially missing Python dependencies. @@ -43,4 +43,4 @@ If in trouble you can also have a look at the CI steps [here](https://github.com Usage --- Use *safpy* as a python package. -Have a look at `examples/test_call.py`! +Have a look at [examples/test_call.py](https://github.com/chris-hld/SAFpy/blob/master/examples/test_call.py) and [examples/block_processing](https://github.com/chris-hld/SAFpy/blob/master/examples/block_processing.py)!