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

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) <anikevicius@gmail.com>
This commit is contained in:
Ignas Anikevicius (gns_ank) 2014-05-24 21:14:06 +01:00 committed by Daniel Hahler
parent 1f948db685
commit d4a4913fd8
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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.