awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README: add reference to online doc, small improvements 

Closes https://github.com/awesomeWM/awesome/pull/345.
This commit is contained in:
Daniel Hahler 2015-07-24 02:25:39 +02:00
parent 9dad4f59a4
commit 3fb83ba9b5
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/01-readme.md
View File

@ -34,14 +34,14 @@ the `DISPLAY` environment variable is set correctly, e.g.:
## Configuration
The configuration of awesome is done by creating a
`$XDG_CONFIG_HOME/awesome/rc.lua` file.
`$XDG_CONFIG_HOME/awesome/rc.lua` file, typically `~/.config/awesome/rc.lua`.
An example configuration named `awesomerc.lua.in` is provided in the source.
## Troubleshooting
In most systems any message printed by awesome (including warnings and errors)
are written to `$HOME/.xsession-errors`.
On most systems any message printed by awesome (including warnings and errors)
is written to `~/.xsession-errors`.
If awesome does not start or the configuration file is not producing the
desired results the user should examine this file to gain insight into the
@ -56,6 +56,11 @@ Please read the @{02-contributing.md} guide for any coding, documentation or pat
## Status
[![Build Status](https://travis-ci.org/awesomeWM/awesome.svg?branch=master)](https://travis-ci.org/awesomeWM/awesome)
## Documentation
Online documentation is available at http://awesome.naquadah.org/doc/, and
can be built using `make ldoc`.
## License
The project is licensed under GNU General Publice License v2 or later.