Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 68 lines (42 sloc) 1.503 kb
9527759 @amolenaar *** empty log message ***
authored
1 Feel free to hack Gaphor. Patches are welcome.
2
9b6651a @wrobell - added info about fetching and installing deps
wrobell authored
3 Fetching Development Dependencies
4 =================================
5
6 Gaphor uses Easy Install to manage in easy way its dependencies.
7
8 To fetch and install dependencies as non-root user
9
10 1. Create ~/.pydistutils.cfg file
11
12 [install]
13 install_lib = ~/opt/share/python2.5/site-packages
14 install_scripts = ~/opt/bin
15
16 2. Create (or extend) PYTHONPATH variable
17
18 export PYTHONPATH=~/opt/share/python2.5/site-packages
19
20 3. Run setup.py script to fetch and install dependencies
21
22 python setup.py develop
23
24 Prefix ~/opt can be changed to something more suitable for your setup.
25
26
27 Above is based on
28
29 http://peak.telecommunity.com/DevCenter/EasyInstall#traditional-pythonpath-based-installation
30
31
eacb927 @wrobell - added a note about running tests
wrobell authored
32 Running Tests
33 =============
34 To run tests on Unix machine
35
36 Xvfb :2.0 &
37 DISPLAY=:2.0 nosetests gaphor/ 2>&1 | tee tests.log
38
39
9527759 @amolenaar *** empty log message ***
authored
40 Structure
41 =========
42
43 Gaphor contains the following modules:
44
45 UML
46 ---
47 The UML module contains the UML 2.0 data model. This part is
48 quite stable and it is unlikely that code has to be changed
49 here.
50
b4fca7f @amolenaar *** empty log message ***
authored
51 NOTE: The code is generated from a Gaphor model: uml2.gaphor. This
52 file can be loaded in gaphor.
53
9527759 @amolenaar *** empty log message ***
authored
54 diagram
55 -------
56 The diagram module contains items that can be placed in diagrams.
57 In most cases the classes NamedItem and Relationship can serve
58 as bases for your class.
59
60 ui
61 --
b4fca7f @amolenaar *** empty log message ***
authored
62 The user interface. This is where most of the work is to be done.
9527759 @amolenaar *** empty log message ***
authored
63
64 misc
65 ----
66 Some utility stuff, such as Actions and aspects are put in here.
b4fca7f @amolenaar *** empty log message ***
authored
67
Something went wrong with that request. Please try again.