README.md

   1 awesome
   2 =======
   3 awesome is a highly configurable, next generation framework window manager for X.
   4
   5 Building and installation
   6 -------------------------
   7 After extracting the dist tarball, run:
   8
   9     make
  10
  11 This will create a build directory, run cmake in it and build awesome.
  12
  13 After building is finished, you can install:
  14
  15     make install  # you might need root permissions
  16
  17 Running awesome
  18 ---------------
  19 You can directly select awesome from your display manager. If not, you can
  20 add the following line to your .xinitrc to start awesome using startx
  21 or to .xsession to start awesome using your display manager:
  22
  23     exec awesome
  24
  25 In order to connect awesome to a specific display, make sure that
  26 the DISPLAY environment variable is set correctly, e.g.:
  27
  28     DISPLAY=foo.bar:1 exec awesome
  29
  30 (This will start awesome on display :1 of the host foo.bar.)
  31
  32 Configuration
  33 -------------
  34 The configuration of awesome is done by creating a
  35 `$XDG_CONFIG_HOME/awesome/rc.lua` file.
  36
  37 An example configuration named "awesomerc.lua.in" is provided in the source.
  38
  39 Troubleshooting
  40 ---------------
  41 In most systems any message printed by awesome (including warnings and errors)
  42 are written to `$HOME/.xsession-errors`.
  43
  44 If awesome does not start or the configuration file is not producing the
  45 desired results the user should examine this file to gain insight into the
  46 problem.
  47
  48 Reporting issues
  49 ----------------
  50 Please report any issues you may find at https://awesome.naquadah.org/bugs/ .
  51 You can submit pull requests at https://github.com/awesomeWM/awesome .