From 9e943442d943d49b50335b14427555aca0f52a54 Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Wed, 9 Jan 2008 14:26:27 +0100 Subject: [PATCH] More detailed elaboration on build requirements --- README | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README b/README index 322a75818..c58933d28 100644 --- a/README +++ b/README @@ -5,13 +5,22 @@ It's based on dwm. 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. -Creating the man pages also requires recent versions of the asciidoc and xmlto -tools. +In order to build the awesome man pages, you need these tools: + - asciidoc (recent version) + - 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 finished, you can follow the following instructions for building a dist 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 of warning flags, add AWESOME_CFLAGS="" to your "make" lines. +The source code reference can be built with "make doc". + Running awesome ----------- Add the following line to your .xinitrc to start awesome using startx