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 If building from git sources, run "./autogen.sh". When autoreconf has
  16 finished, you can follow the following instructions for building a dist
  17 tarball.
  18
  19 After extracting the dist tarball, run "./configure --help" and figure out
  20 what you might want to adapt for your system. Then run ./configure with the
  21 proper parameters, and build and install:
  22
  23   ./configure [...]
  24   make
  25   make install # might need root permissions
  26
  27 If you're using gcc as your compiler and do not want awesome's default set
  28 of warning flags, add AWESOME_CFLAGS="" to your "make" lines.
  29
  30 Running awesome
  31 -----------
  32 Add the following line to your .xinitrc to start awesome using startx
  33 or to .xsession to start awesome using gdm/kdm/xdm...:
  34
  35     exec awesome
  36
  37 In order to connect awesome to a specific display, make sure that
  38 the DISPLAY environment variable is set correctly, e.g.:
  39
  40     DISPLAY=foo.bar:1 exec awesome
  41
  42 (This will start awesome on display :1 of the host foo.bar.)
  43
  44 Configuration
  45 -------------
  46 The configuration of awesome is done by creating a ~/.awesomerc file.
  47 An example is provided in the sources.