From 3fb83ba9b5cbe39afab146d1350fb5d723026021 Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Fri, 24 Jul 2015 02:25:39 +0200 Subject: [PATCH] README: add reference to online doc, small improvements Closes https://github.com/awesomeWM/awesome/pull/345. --- docs/01-readme.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/01-readme.md b/docs/01-readme.md index 86cc3bc3..05290164 100644 --- a/docs/01-readme.md +++ b/docs/01-readme.md @@ -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.