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

README: add 'Reporting issues' section and formatting

This commit is contained in:
Daniel Hahler 2014-04-07 23:21:25 +02:00
parent afa50904fb
commit 3ad78570d6
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README
View File

@ -6,13 +6,13 @@ Building and installation
------------------------- -------------------------
After extracting the dist tarball, run: After extracting the dist tarball, run:
make make
This will create a build directory, run cmake in it and build awesome. This will create a build directory, run cmake in it and build awesome.
After building is finished, you can install: After building is finished, you can install:
make install # you might need root permissions make install # you might need root permissions
Running awesome Running awesome
--------------- ---------------
@ -31,13 +31,21 @@ the DISPLAY environment variable is set correctly, e.g.:
Configuration Configuration
------------- -------------
The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file. 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 Troubleshooting
--------------- ---------------
In most systems any message printed by awesome (including warnings and errors) In most systems any message printed by awesome (including warnings and errors)
are written to $HOME/.xsession-errors. are written to `$HOME/.xsession-errors`.
If awesome does not start or the configuration file is not producing the desired If awesome does not start or the configuration file is not producing the
results the user should examine this file to gain insight into the problem. desired results the user should examine this file to gain insight into the
problem.
Reporting issues
----------------
Please report any issues you may find at https://awesome.naquadah.org/bugs/ .
You can submit pull requests at https://github.com/awesomeWM/awesome .