Skip to content

Commit

Permalink
📝 Improve Instructions in README.md
Browse files Browse the repository at this point in the history
Improved the startup instructions to give better information and context behind starting `scriptorium`
  • Loading branch information
KagemniKarimu committed Jan 9, 2025
1 parent b654e21 commit 19d4533
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# scriptorium
the universal manuscript livebook & learning center
![scriptorium_logo_alpha.png](files/scriptorium_logo_alpha.png)

# quick start
Pull and run the container directly:
Expand All @@ -8,10 +9,16 @@ Pull and run the container directly:
docker run --rm -p 8080:8080 -p 8081:8081 kagemnikarimu/scriptorium
```

Note: Ports must be mapped to access:
- 8080: Main interface
- 8081: LiveBook server

# build yourself
`git clone` and then

Clone and build locally:

```bash
git clone https://github.com/kagemnikarimu/scriptorium
cd scriptorium
docker build -t scriptorium .
docker run --rm -p 8080:8080 -p 8081:8081 scriptorium
Expand Down

0 comments on commit 19d4533

Please sign in to comment.