-
Notifications
You must be signed in to change notification settings - Fork 2
/
INSTALL
86 lines (52 loc) · 2.45 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
DocGenerator INSTALL
====================
Required software
-----------------
You need to have the GNUstep core libraries installed in order to compile and
use DocGenerator (aka **etdocgen**). The core packages are, at a minimum:
* gnustep-make
* gnustep-base
* gnustep-gui
* gnustep-back
See <http://www.gnustep.org/> for further information.
You also need to have the Graphviz libraries and Discount tool installed:
* libgvc
* markdown
See <http://www.graphviz.org/> and
<http://www.pell.portland.or.us/~orc/Code/discount/> for further information.
Finally you need from Etoile itself:
* EtoileFoundation, which can be found in Etoile/Frameworks/EtoileFoundation
* SourceCodeKit, which can be found in Etoile/Languages/SourceCodeKit
These last dependencies are automatically handled when DocGenerator is built by
running 'make' tool in the root 'Etoile' directory of the current branch.
Build and Install
-----------------
Square brackets "[ ]" are used to indicate optional parameters.
Steps to build:
* make
* [sudo [-E]] make install
Mac OS X support
----------------
**Warning:** Xcode 4 is required to build the project.
For Mac OS X, you must download and install Graphviz and Discount.
For installation purpose, [Graphviz website](http://www.graphviz.org/Download_macos.php)
provides a .pkg bundle that can be double-clicked. This should install Graphivz
in /usr/local, where DocGenerator Xcode project searches for Graphviz headers
and library.
For Discount, you have to download the source code. First, Xcode command-line
tools must be installed to get a working Unix toolchain. To do so, go to the
Downloads tab in the Xcode preferences, then in the Program Components subtab.
If 'Command-Line Tools' are not installed, click the button 'Install'.
Now launch the Terminal, in the shell go the Discount directory. Now build and
and install Discount as shown below:
./configure.sh && make && sudo -E make install
This should install Discount library and tool into /usr/local. For running
DocGenerator inside Xcode, the 'discount' tool must be installed in
/usr/local/bin. If the tool is run from the shell, the 'discount' tool directory
must be in your shell PATH variable.
**Note:** You must also install libclang headers as explained in SourceCodeKit
INSTALL.
Trouble
-------
Give us feedback! Tell us what you like; tell us what you think
could be better. Send bug reports and patches to <[email protected]>.