Skip to content
This repository was archived by the owner on Dec 7, 2021. It is now read-only.

Commit 1a335de

Browse files
committed
readme: add some lame usage information
1 parent 205eb5d commit 1a335de

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@ Wikimedia Developer Portal
33

44
Static site generator for a portal to Wikimedia technical documentation.
55

6+
Quick start
7+
-----------
8+
Possibly informative placeholder for using this repo to generate and review
9+
the site.
10+
11+
```console
12+
$ git clone git@github.com:bd808/developer-portal.git
13+
$ cd developer-portal
14+
$ make start
15+
$ open http://127.0.0.1:9000/
16+
17+
$ vim docs/index.md
18+
$ make build
19+
$ open http://127.0.0.1:9000/
20+
```
21+
622
License
723
-------
824
Wikimedia Developer Portal code and configuration is licensed under the [GNU GPLv3+][] license. Textual content is licensed under the [CC-BY-SA 3.0][] license.

0 commit comments

Comments
 (0)