github.com -> github.io
[build-cgdb.git] / README.txt
blobd840371be0af90178f4c9cb31ae2c211018e62d8
1 README FOR BUILD-CGDB
2 =====================
3 The build-cgdb project builds a standalone, universal cgdb executable that runs
4 on Mac OS X 10.4 or later.
6 In addition, it creates a convenient installer to install the
7 /usr/local/bin/cgdb executable, the /usr/local/share/man/man1/cgdb.1 man page,
8 the /usr/local/share/info/cgdb.info info file and the
9 /usr/local/share/cgdb/cgdb.txt files.
11 The resulting installer is compatible with Mac OS X 10.4 and later.
13 --------
14 Building
15 --------
16 Simply run the build script and all necessary files will be downloaded and then
17 cgdb will be built and a cgdb.dmg disk image created containing the cgdb
18 installer.
20 ------------
21 Requirements
22 ------------
23 In order to build the installer, fakeroot must be installed.  A compatible
24 version of fakeroot can be installed from the github
25 http://mackyle.github.io/fakeroot site.
27 In order to build, the Mac OS X 10.4u SDK is required as well as the developer
28 tools (with gcc version 4.0) and building requires Mac OS X 10.4 or later.
30 -------
31 License
32 -------
33 The cgdb sources are licensed with GPLv2 (or later) and require Readline
34 version 5.1 or later.  Readline 5.2 is the last GPLv2 (or later) licensed
35 version of Readline (Readline 6 is GPLv3 or later).  The built OS X cgdb
36 executable included in the installer is linked against a version 5.2 Readline
37 library so the entire work remains GPLv2 (or later).
39 -----
40 Links
41 -----
42 cgdb home page:      http://cgdb.github.com/
43 cgdb GitHub page:    https://github.com/cgdb/cgdb
44 old cgdb sf page:    http://sourceforge.net/projects/cgdb/
45 old cgdb support:    http://cgdb.sourceforge.net/support.php
46 Readline tarball:    http://ftp.gnu.org/gnu/readline/readline-5.2.tar.gz
47 OS X Installers:     https://github.com/mackyle/build-cgdb/downloads