Update README: requirements/hacking section (#57)
This commit is contained in:
parent
48697b9f6e
commit
69d24b919a
23
README.md
23
README.md
|
@ -5,9 +5,24 @@
|
||||||
This is the main source of the
|
This is the main source of the
|
||||||
[website for the awesome window manager](https://awesomewm.org/).
|
[website for the awesome window manager](https://awesomewm.org/).
|
||||||
|
|
||||||
The website is based on [ikiwiki](https://ikiwiki.info/). You can build the web
|
## Requirements
|
||||||
page locally by running `make`. The result will be in `html/`. Besides ikiwiki,
|
|
||||||
you will also need [PerlMagick](https://www.imagemagick.org/script/perl-magick.php).
|
- [ikiwiki](https://ikiwiki.info/)
|
||||||
|
- [PerlMagick](https://www.imagemagick.org/script/perl-magick.php) (optional,
|
||||||
|
for images)
|
||||||
|
|
||||||
|
## Hacking
|
||||||
|
|
||||||
|
You can build the web page locally by running `make`, which will generate the
|
||||||
|
output in `html/`.
|
||||||
|
|
||||||
|
To view it, open `html/index.html` in your web browser.
|
||||||
|
|
||||||
|
You can simulate running a web server using Python, which will automatically
|
||||||
|
open `index.html` when following a link to a directory:
|
||||||
|
|
||||||
|
$ cd html
|
||||||
|
$ python3 -m http.server -b localhost 8000 &
|
||||||
|
|
||||||
## Publishing
|
## Publishing
|
||||||
|
|
||||||
|
@ -18,7 +33,7 @@ through [Github's Organization Pages](https://github.com/awesomeWM/awesomeWM.git
|
||||||
## Other resources
|
## Other resources
|
||||||
|
|
||||||
The API documentation for the master branch at
|
The API documentation for the master branch at
|
||||||
[/apidoc](https://awesomewm.org/apidoc/) is served through [Github's Project
|
[/apidoc](https://awesomewm.org/apidoc/) is viewable at [Github's Project
|
||||||
Pages for the apidoc repo](https://github.com/awesomeWM/apidoc), where it gets
|
Pages for the apidoc repo](https://github.com/awesomeWM/apidoc), where it gets
|
||||||
pushed to from successful builds in [the awesome main
|
pushed to from successful builds in [the awesome main
|
||||||
repo](https://github.com/awesomeWM/awesome/).
|
repo](https://github.com/awesomeWM/awesome/).
|
||||||
|
|
Loading…
Reference in New Issue