More detailed elaboration on build requirements

This commit is contained in:
Hans Ulrich Niedermann 2008-01-09 14:26:27 +01:00 committed by Julien Danjou
parent 4f05f954d0
commit 9e943442d9
1 changed files with 16 additions and 5 deletions

21
README
View File

@ -5,13 +5,22 @@ It's based on dwm.
Requirements Requirements
------------ ------------
In order to build awesome itself, you need header files and libs of:
- Xlib, Xinerama, Xrandr, Xft
- libconfuse >= 2.6
- cairo
In order to build awesome you need the Xlib header files, libconfuse and cairo. In order to build the awesome man pages, you need these tools:
Creating the man pages also requires recent versions of the asciidoc and xmlto - asciidoc (recent version)
tools. - xmlto (recent version)
- docbook XSL stylesheets
Installation In order to build the source code reference, you need these tools:
------------ - doxygen
- graphviz
Building and Installation
-------------------------
If building from git sources, run "./autogen.sh". When autoreconf has If building from git sources, run "./autogen.sh". When autoreconf has
finished, you can follow the following instructions for building a dist finished, you can follow the following instructions for building a dist
tarball. tarball.
@ -27,6 +36,8 @@ proper parameters, and build and install:
If you're using gcc as your compiler and do not want awesome's default set If you're using gcc as your compiler and do not want awesome's default set
of warning flags, add AWESOME_CFLAGS="" to your "make" lines. of warning flags, add AWESOME_CFLAGS="" to your "make" lines.
The source code reference can be built with "make doc".
Running awesome Running awesome
----------- -----------
Add the following line to your .xinitrc to start awesome using startx Add the following line to your .xinitrc to start awesome using startx