diff --git a/README.md b/README.md index 96cebe0..b8d0e27 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,31 @@ al. (https://doi.org/10.1007/978-3-319-68852-7)). ## Installation -Navigate to the repository folder and run +### Manual installation + +Clone the repository + +```bash +git clone https://github.com/matthiasprobst/synpivimage +``` + +Then navigate into the repo directory and install the package: ```bash -pip install synpivimage +cd synpivimage/ +pip install . ``` +For development adjust the installation to: + +```bash +pip install -e . +``` + +### Via pypi + +*Not yet available* + ## Documentation A comprehensive documentation can be found [here](https://synpivimage.readthedocs.io/en/latest/).