a3ab57a5a4
|
||
|---|---|---|
| images | ||
| src@58fed31d88 | ||
| templates | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| Makefile | ||
| README.md | ||
| community.mdwn | ||
| doc.mdwn | ||
| doing_a_release.mdwn | ||
| download.mdwn | ||
| index.mdwn | ||
| local.css | ||
| releases.mdwn | ||
| screenshots.mdwn | ||
README.md
Website for awesome WM
This is the main source of the website for the awesome window manager.
Requirements
- ikiwiki
- PerlMagick (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 &
Contribution Guide
Screenshots
To contribute with Screenshots:
- Add your image to the folder images/screenshots with an appropiated name.
- Add a new
tag in the bottom of screenshots.mdwn, - Inside the new tag, add the screenshots with a tag and use the
to add caption to the image, explaining what is being used on the screenshot.
Publishing
The master branch gets built by Travis CI, and is then published through Github's Organization Pages.
Other resources
The API documentation for the master branch at /apidoc is viewable at Github's Project Pages for the apidoc repo, where it gets pushed to from successful builds in the awesome main repo.