README

   1 awesome
   2 =======
   3 awesome is an extremely fast, small, and dynamic window manager for X.
   4
   5 Requirements
   6 ------------
   7 In order to build awesome itself, you need header files and libs of:
   8   - cmake
   9   - Xlib, xcb and xcb-util (>= 0.2.1)
  10   - Lua 5.1
  11   - cairo
  12   - pango and pangocairo
  13   - libev
  14   - glib
  15   - GdkPixBuf or Imlib2 (use -DWITH_IMLIB2=ON with cmake)
  16   - dbus (optional, use -DWITH_DBUS=OFF with cmake to disable)
  17   - gperf
  18
  19 In order to build the awesome man pages and documentation,
  20 you need these tools:
  21   - asciidoc
  22   - xmlto
  23   - docbook XSL stylesheets
  24   - luadoc
  25
  26 In order to build the source code reference, you need these tools:
  27   - doxygen
  28   - graphviz
  29
  30 Building and Installation
  31 -------------------------
  32 After extracting the dist tarball, run:
  33
  34   make
  35
  36 This will create a build directory, run cmake in it and build awesome.
  37
  38 After the building done, you can type this to install:
  39
  40   make install # might need root permissions
  41
  42 Running awesome
  43 -----------
  44 Add the following line to your .xinitrc to start awesome using startx
  45 or to .xsession to start awesome using gdm/kdm/xdm...:
  46
  47     exec awesome
  48
  49 In order to connect awesome to a specific display, make sure that
  50 the DISPLAY environment variable is set correctly, e.g.:
  51
  52     DISPLAY=foo.bar:1 exec awesome
  53
  54 (This will start awesome on display :1 of the host foo.bar.)
  55
  56 Configuration
  57 -------------
  58 The configuration of awesome is done by creating a $XDG_CONFIG_HOME/awesome/rc.lua file.
  59 An example is provided in the sources.