Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matthiasprobst committed Oct 17, 2024
1 parent 4f6caeb commit 69af31d
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down

0 comments on commit 69af31d

Please sign in to comment.