Skip to content

Commit

Permalink
Merge pull request #5 from bpedersen2/add-readme
Browse files Browse the repository at this point in the history
Add a minimal readme
  • Loading branch information
jl-wynen authored Feb 1, 2024
2 parents 87a39ed + c603e98 commit 79c5825
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
SCIWYRM -- render jupyter notebooks for scicat data
===================================================

For development
===============
installing (in a python 3.11+ environment):
```
pip install "uvicorn[standard]"
pip install -e .
```

running:

```
uvicorn sciwyrm.main:app --reload
```

access:

```
navigate browser to:
http://localhost:8000/docs
```

0 comments on commit 79c5825

Please sign in to comment.