Skip to content

Commit 91f5957

Browse files
mcomellatrollixx
authored andcommitted
docs(readme): add initial with build instructions (#15)
1 parent d812e56 commit 91f5957

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# zealdocs.github.io
2+
https://zealdocs.org/: web documentation for [Zeal, an offline documentation browser][zeal].
3+
4+
## Development
5+
To build this static site, you need the following dependencies:
6+
- `jekyll` (`v3.1.6` from Ubuntu 18.04 works correctly)
7+
8+
To perform a one-off build, run:
9+
```sh
10+
jekyll build
11+
```
12+
13+
To build any time a source code file changes and locally host the results at `http://127.0.0.1:4000/`, run:
14+
```sh
15+
jekyll serve
16+
```
17+
18+
For more information on jekyll usage, see [the official jekyll documentation](https://jekyllrb.com/docs/usage/).
19+
20+
[zeal]: https://github.com/zealdocs/zeal

0 commit comments

Comments
 (0)