Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update README.md

[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Update README.md
  • Loading branch information
lukasalexanderweber committed Oct 8, 2023
1 parent 9d99eab commit 1931ccc
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ pip install stitching

## Usage

### Python CLI

The command line interface
([cli](https://github.com/lukasalexanderweber/stitching/tree/main/stitching/cli/stitch.py))
is available after installation
Expand All @@ -41,6 +43,21 @@ Enable verbose mode with `stitch * -v`.
This will create a folder where all intermediate results are stored so that
you can find out where there are problems with your images, if any

### Docker CLI

If you are familiar with Docker and don't feel like
setting up Python and an environment, you can also use the
[openstitching/stitch](https://hub.docker.com/r/openstitching/stitch)
Docker image

`docker container run --rm -v
/path/to/data:/data openstitching/stitch:{version} -h`

You can use the CLI as described above
(read "current directory" as "/data directory")

### Python Script

You can also use the Stitcher class in your script

```python
Expand Down

0 comments on commit 1931ccc

Please sign in to comment.