diff options
| -rw-r--r-- | doc/chickadee.texi | 48 |
1 files changed, 42 insertions, 6 deletions
diff --git a/doc/chickadee.texi b/doc/chickadee.texi index 5a19fcd..655036f 100644 --- a/doc/chickadee.texi +++ b/doc/chickadee.texi @@ -66,15 +66,13 @@ The document was typeset with @chapter Installation Chickadee is available for download from its website at -@url{dthompson.us/projects/chickadee.html}. This section describes -the software requirements of Chickadee, as well as how to install it. - -The build procedure for Chickadee is the same as for GNU software -packages, and is not covered here. Please see the files @file{README} -and @file{INSTALL} for additional details. +@url{https://dthompson.us/projects/chickadee.html}. This section +describes the software requirements of Chickadee, as well as how to +install it. @menu * Requirements:: Software needed to build and run Chickadee. +* Building:: How to build from source. @end menu @node Requirements @@ -93,6 +91,44 @@ Chickadee depends on the following packages: @item libvorbisfile @end itemize +If you are using Guix, then this getting all the dependencies is easy: +Just run @command{guix shell} from the root of the Chickadee Git +repository or unpacked release tarball. + +@node Building +@section Building + +If you are building from a Git checkout rather than an official +release tarball, the first step is to bootstrap the build system: + +@example +./bootstrap.sh +@end example + +Release tarballs have a pre-bootstrapped build system and do not +require the above step. + +Now, build Chickadee: + +@example +./configure +make +@end example + +If you'd like to install Chickadee onto your system, run: + +@example +sudo make install +@end example + +The GNU build system defaults to @file{/usr/local} as the installation +prefix. This can be changed by re-running the configure script: + +@example +./configure --prefix=/some/where/else +sudo make install +@end example + @node Getting Started @chapter Getting Started |