aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..5fca6ed
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,25 @@
1# Homer docs
2
3Live on github pages: [https://bastienwirtz.github.io/homer/](https://bastienwirtz.github.io/homer/)
4
5## Local development
6
7### Install Python dependencies
8
9Homer's documentation is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To get started, you'll need Python 3 installed on your machine and set up your local environment.
10
11```sh
12python -m venv venv
13source venv/bin/activate
14pip install -r requirements.txt
15```
16
17### Preview local copy
18
19MkDocs comes with a command-line utility for building and serving the static documentation site every time you save a file. To launch it, run the `serve` command.
20
21```sh
22mkdocs serve
23```
24
25Your local version of the docs site will now be available at http://localhost:8000/.