lic/info_running.txt at master · echristophe/lic · GitHub

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
"""
    Lic - Instruction Book Creation software
    Copyright (C) 2010 Remi Gagne

    This file (info_running.txt) is part of Lic.

    Lic is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Lic is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see http://www.gnu.org/licenses/
"""

** Requirements for running Lic from source: **

- Python, any version *before* 3.0

- Qt version 4.6.3 or greater.  There's a bug in Qt 4.6.2 and earlier that make Lic *not* work:
http://bugreports.qt.nokia.com/browse/QTBUG-7880

- PyQt, any version that works with the above Python & Qt.

- PyOpenGL, any version

- Python Image Libary (PIL), any version

The source includes a PyDev .project file, if you have Eclipse & PyDev handy.

** Source tree overview **

Lic.py contains the main entry point and window application code.

LicInstructions.py contains the main Instructions class, which maintains the
state of a single instruction book.

LicCustomPages.py contains the important Page class, plus TitlePage and
PartListPage subclasses.

LicModel.py contains the other basic classes you'd expect, which each represent
one 'thing' within in an instruction book (Step, CSI, PLI, etc).

LicBinaryReader & Writer contain all of the binary load / save stuff.

LicGraphicsWidget contains the important QGraphicScene subclass, which is
responsible for the physical display of an instruction book on a portion of the
application window.

LicTreeModel contains the QAbstractItemModel subclass which tracks the data
model for the navigation tree.  The tree widget itself is trivial, and lives in
Lic.py

LicUndoActions holds - you guessed it - all of the code for each custom
undo / redo action.

LicDialogs contains every single dialog subclass used by Lic.  I like all that
nasty UI widget code in one spot.

Remi