From d4a4913fd879cfbab0cb7028984555c9ec542f43 Mon Sep 17 00:00:00 2001 From: "Ignas Anikevicius (gns_ank)" Date: Sat, 24 May 2014 21:14:06 +0100 Subject: [PATCH] Docs: Minor fixes to the README Fix some syntax, so that we have the sections separated by empty lines (my pandoc syntax plugin was not working correctly without it). Also, add a sentence on the CONTRIBUTING guide. Signed-off-by: Ignas Anikevicius (gns_ank) --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 059e04f5..5a7503c5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ awesome ======= + awesome is a highly configurable, next generation framework window manager for X. Building and installation ------------------------- + After extracting the dist tarball, run: make @@ -16,28 +18,31 @@ After building is finished, you can install: Running awesome --------------- + You can directly select awesome from your display manager. If not, you can add the following line to your .xinitrc to start awesome using startx -or to .xsession to start awesome using your display manager: +or to `.xsession` to start awesome using your display manager: exec awesome In order to connect awesome to a specific display, make sure that -the DISPLAY environment variable is set correctly, e.g.: +the `DISPLAY` environment variable is set correctly, e.g.: DISPLAY=foo.bar:1 exec awesome -(This will start awesome on display :1 of the host foo.bar.) +(This will start awesome on display `:1` of the host foo.bar.) Configuration ------------- + The configuration of awesome is done by creating a `$XDG_CONFIG_HOME/awesome/rc.lua` file. -An example configuration named "awesomerc.lua.in" is provided in the source. +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`. @@ -47,5 +52,6 @@ problem. Reporting issues ---------------- -Please report any issues you may find at https://github.com/awesomeWM/awesome/issues. -You can submit pull requests at https://github.com/awesomeWM/awesome. +Please report any issues you may find on [our bugtracker](https://github.com/awesomeWM/awesome/issues). +You can submit pull requests on the [github repository](https://github.com/awesomeWM/awesome). +Please read the @{CONTRIBUTING.md} guide for any coding, documentation or patch guidelines.