1= Build instructions =
2
3== Building ==
4
5Building this package from a distribution tarball should be as simple as
6running make.  Install with "make install" as root.
7
8You will need xmlto to build the derived forms of the documentation
9from the DocBook-XML sources.  If you are going no modify the website,
10you will also need to have asciidoc and the ImageMagick convert(1)
11utility installed.
12
13== Testing ==
14
15You can run "make check" after the library and utilities have been built
16to see a regression test of the codebase. No output (other than
17the test header lines) is good news.
18
19== Portability note ==
20
21This codebase now assumes your compiler is C99-conformant.  If it
22isn't, the most likely trouble spot is "#include <stdint.h>"; your
23compiler may be looking for "inttypes.h" instead.  By test, the code
24is backward-conformant to C89 except that it uses bool/true/false.
25
26One (minimal but sufficient) concession to Windows portability has been
27make; inclusion of <unistd.h> is conditional on _WIN32 not being
28defined by the compiler (if it is <io.h> is included
29instead). Requests to go any further out of the way to accommodate
30Microsoft's toolchains are unlikely be looked on favorably.
31
32== Release Procedure ==
33
341. Check the SourceForge tracker for bugs and patches.
35
362. Bump the version number in gif_lib.h.  Do "make version"
37   to confirm that it looks sane when extracted to the Makefile.
38
393. Version-stamp the top entry in the NEWS file.
40
414. If you are changing major versions, sync the XBS-SourceForge-Folder
42   attribute in the control file.
43
445. 'make dist' to make a tarball.
45
466. Tag the release in the repo.
47
487. Ship the release tarball.
49
50The last three steps can be done with "make release" if you have shipper
51installed.
52
53