some minor doc corrections/todos
[nobug.git] / doc / buildinstall.txt
blob43de6508141144e437cbd55b07de28f6495195d4
1 Building and Installing
2 -----------------------
4 Release Tarballs
5 ~~~~~~~~~~~~~~~~
7 TODO describe where to obtain releases
9 Gpg signed tarballs are being used for distribution. The first step involves
10 checking the signature:
12 $ gpg nobug-X.Y.tar.gz.gpg
14 This will produce a nobug-X.Y.tar.gz and report if the signature could be
15 validated.
17 Since they are built with gnu autotools, the usual build and install procedure
18 will work:
20 $ tar xzvf nobug-X.Y.tar.gz
21 $ cd nobug-X.Y
22 $ ./configure
23 $ make
24 $ make install
26 Development Version via git
27 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
29 The development version is available via git from 'git://git.pipapo.org/nobug'
30 or mirrored at repo.or.cz 'git://repo.or.cz/nobug.git'.
32 After you have cloned the repository, you'll then have to bootstrap the
33 autotools first:
35 $ autoreconf -i
37 Then the usual ./configure && make && make install will work.
39 There is a special makefile target make meta to bring several files (README,
40 AUTHORS, NEWS) in sync with the NoBug documentation wiki and update the
41 changelog.
43 What Is Installed
44 ~~~~~~~~~~~~~~~~~
46 Currently, NoBug installs the following:
48   * A single nobug.h headerfile which your code will use
49   * Two libs that are used by statically linking:
50       + 'libnobug.a' for singlethreaded programs.
51       + 'libnobugmt.a' for multithreaded programs.