Skip to content

Commit 46bb1b5

Browse files
committed
update readme
1 parent d580514 commit 46bb1b5

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
[![Publish docs via GitHub Pages](https://github.com/omnipackage/omnipackage-docs/actions/workflows/release-gh-pages.yml/badge.svg)](https://github.com/omnipackage/omnipackage-docs/actions/workflows/release-gh-pages.yml)
22
[![pages-build-deployment](https://github.com/omnipackage/omnipackage-docs/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/omnipackage/omnipackage-docs/actions/workflows/pages/pages-build-deployment)
3+
4+
# OmniPackage documentation
5+
6+
Created with [mkdocs](https://www.mkdocs.org) and [mkdocs-material](https://squidfunk.github.io/mkdocs-material)
7+
8+
Install dependencies:
9+
10+
```shell
11+
make deps
12+
```
13+
14+
Run with live reload:
15+
16+
```shell
17+
make serve
18+
```
19+
20+
Build static site (output in `site/`):
21+
22+
```shell
23+
make build
24+
```

0 commit comments

Comments
 (0)