README

   1 awesome
   2 =======
   3 awesome is an extremely fast, small, and dynamic window manager for X.
   4 It's based on dwm.
   5
   6 Requirements
   7 ------------
   8
   9 In order to build awesome you need the Xlib header files, libconfuse and cairo.
  10 Creating the man pages also requires recent versions of the asciidoc and xmlto
  11 tools.
  12
  13 Installation
  14 ------------
  15 Edit config.mk to match your local setup (awesome is installed into
  16 the /usr/local namespace by default).
  17
  18 Afterwards enter the following command to build and install awesome (if
  19 necessary as root):
  20
  21     make install
  22
  23 Running awesome
  24 -----------
  25 Add the following line to your .xinitrc to start awesome using startx
  26 or to .xsession to start awesome using gdm/kdm/xdm...:
  27
  28     exec awesome
  29
  30 In order to connect awesome to a specific display, make sure that
  31 the DISPLAY environment variable is set correctly, e.g.:
  32
  33     DISPLAY=foo.bar:1 exec awesome
  34
  35 (This will start awesome on display :1 of the host foo.bar.)
  36
  37 Configuration
  38 -------------
  39 The configuration of awesome is done by creating a ~/.awesomerc file.
  40 An example is provided in the sources.