Add a README (#21)

This commit is contained in:
Daniel Hahler 2016-05-18 10:34:08 +02:00
parent 4fd28e1639
commit 9ba7e14cb2
2 changed files with 24 additions and 1 deletions

View File

@ -6,7 +6,8 @@ all: output ldoc changelogs manpages
output: authors.mdwn
ikiwiki $(CURDIR) html -v --wikiname about --plugin=goodstuff \
--templatedir=templates --exclude=html --exclude=Makefile
--templatedir=templates \
--exclude=html --exclude=Makefile --exclude=README.md
authors.mdwn:
echo '## Primary' > authors.mdwn

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Website for awesome WM
[![Build Status](https://travis-ci.org/awesomeWM/awesome-www.svg?branch=master)](https://travis-ci.org/awesomeWM/awesome-www)
This is the main source of the
[website for the awesome window manager](https://awesomewm.org/).
The website is based on [ikiwiki](https://ikiwiki.info/).
## Publishing
The master branch gets built by
[Travis CI](https://travis-ci.org/awesomeWM/awesome-www/), and is then published
through [Github's Organization Pages](https://github.com/awesomeWM/awesomeWM.github.io).
## Other resources
The API documentation for the master branch at
[/apidoc](https://awesomewm.org/apidoc/) is served through [Github's Project
Pages for the apidoc repo](https://github.com/awesomeWM/apidoc), where it gets
pushed to from successful builds in [the awesome main
repo](https://github.com/awesomeWM/awesome/).