mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
doc: fix README
Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
parent
17744fc81d
commit
242c0b5a91
1 changed files with 5 additions and 12 deletions
17
README
17
README
|
@ -15,10 +15,12 @@ In order to build awesome itself, you need header files and libs of:
|
|||
- dbus (optional, use --with-dbus=no with ./configure to disable)
|
||||
- gperf
|
||||
|
||||
In order to build the awesome man pages, you need these tools:
|
||||
In order to build the awesome man pages and documentation,
|
||||
you need these tools:
|
||||
- asciidoc (recent version)
|
||||
- xmlto (recent version)
|
||||
- docbook XSL stylesheets
|
||||
- luadoc
|
||||
|
||||
In order to build the source code reference, you need these tools:
|
||||
- doxygen
|
||||
|
@ -26,21 +28,12 @@ In order to build the source code reference, you need these tools:
|
|||
|
||||
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.
|
||||
After extracting the dist tarball, run:
|
||||
|
||||
After extracting the dist tarball, run "./configure --help" and figure out
|
||||
what you might want to adapt for your system. Then run ./configure with the
|
||||
proper parameters, and build and install:
|
||||
|
||||
./configure [...]
|
||||
cmake .
|
||||
make
|
||||
make install # might need root permissions
|
||||
|
||||
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
|
||||
|
|
Loading…
Reference in a new issue