Skip to content

Commit f2631ca

Browse files
committed
Add README
1 parent 322f313 commit f2631ca

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Hyperdiv Docs
2+
3+
This repo contains the Hyperdiv documentation app, which is written in Hyperdiv.
4+
5+
![hyperdiv-docs](https://github.com/hyperdiv/hyperdiv-docs/assets/5980501/6184856b-fb25-40d0-a3ae-08281fd01ca9)
6+
7+
# Opening the Documentation App
8+
9+
The documentation app ships with Hyperdiv when installing Hyperdiv from PyPI. After installing Hyperdiv, run this command to open the docs app in a browser tab:
10+
```
11+
hyperdiv docs
12+
```
13+
14+
# For Developers
15+
16+
After cloning the Hyperdiv repo and installing its dependencies, you can simply clone this repo and run its `start.py` script within Hyperdiv's Poetry virtualenv:
17+
```sh
18+
cd hyperdiv
19+
# Install dependencies
20+
poetry install
21+
# Enter the virtualenv
22+
poetry shell
23+
# Run the docs app in the virtualenv
24+
cd ../hyperdiv-docs
25+
python start.py
26+
```

0 commit comments

Comments
 (0)