README

Sat, 07 Apr 2012 21:19:24 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 07 Apr 2012 21:19:24 +0200
changeset 1770
c17e67e69ef5
parent 1225
254ec677c775
child 3682
2543741b47b7
child 3759
fd807884e316
permissions
-rw-r--r--

Added a tool to take screenshots (fullscreen or rectangular selection).

59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
1 README for the eric5 IDE
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 Installation
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
5 Installing eric5 is a simple process. Just execute the install.py script
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 (type python install.py -h for some help). Please note that the installation
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 has to be performed using the administrators account (i.e. root on linux).
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 This installs a wrapper script in the standard executable directory
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
9 (default: /usr/local/bin on linux) called eric5.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 If you want to uninstall the package just execute the uninstall script. This
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 gets rid of all installed files. In this case please send an email to the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 below mentioned address and tell me your reason. This might give me a hint on
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
14 how to improve eric5.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 If the required packages (Qt4, QScintilla2, sip and PyQt4) are not installed,
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 please get them and install them in the following order (order is important).
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
19 1. Install Qt4 (from Nokia)
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
21 2. Build and install QScintilla2 (from Riverbank Computing)
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
23 3. Build and install sip (from Riverbank Computing)
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
25 4. Build and install PyQt4 (from Riverbank Computing)
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 5. Build and install QScintilla2 Python bindings
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
28 (part of the QScintilla2 package)
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
30 6. Install eric5
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 If you want to use the interfaces to other supported software packages, you may
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 install them in any order and at any time.
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
34
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
35 Please note, that the QScintilla2 Python bindings have to be rebuild, if
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
36 the PyQt4 package gets updated. If this step is omitted, a bunch of strange
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
37 errors will occur.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 Installation of translations
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
41 Translations of the eric5 IDE are available as separate downloads. There
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 are two ways to install them.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
44 The first possibility is to install them together with eric5. In order
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 to do that, simply extract the downloaded archives into the same place
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
46 as the eric5 archive and follow the installation instructions above.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 The second possibility is to install them separately. Extract the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 downloaded archives and execute the install-i18n.py script (type
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 python install-i18n.py -h for some help). This way you can make the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 translations available to everybody or just to the user executing the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 installation command (if using the -p switch).
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 Running
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
56 Just call up eric5, which will start the IDE. Use the "what is"-help
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 (arrow with ?) to get some help. Sorry, there is no documentation yet.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 To start the unit test module in a standalone variant simply call up
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
59 eric5-unittest. This will show the same dialog (though with a little bit less
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
60 functionality) as if started from within eric5. The helpviewer can be
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
61 started as a standalone program by executing the eric5-webbrowser script.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
63 Please note, the first time you start eric5 it will recognize, that it
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 hasn't been configured yet and will show the configuration dialog.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 Please take your time and go through all the configuration items.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 However, every configuration option has a meaningful default value.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67
100
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
68 Running from the sources
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
69
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
70 If you want to run eric5 from within the source tree you have to execute
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
71 the compileUiFiles.py script once after a fresh checkout from the source
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
72 repository or when new dialogs have been added. Thereafter just execute
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
73 the eric5.py script.
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
74
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 Tray starter
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
77 eric5 comes with a little utility called "eric5-tray". This embeds an icon
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
78 in the system tray, which contains a context menu to start eric5 and all
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
79 it's utilities. Double clicking this icon starts the eric5 IDE.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 Autocompletion/Calltips
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
83 eric5 provides an interface to the QScintilla auto-completion and calltips
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 functionality. QScintilla2 comes with API files for Python and itself. PyQt4
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 contains an API file as well. These are installed by default, if the correct
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
86 installation order (see above) is followed. An API file for eric5 is
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 installed in the same place.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
89 In order to use autocompletion and calltips in eric5 please configure these
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 functions in the "Preferences Dialog" on the "Editor -> APIs",
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 "Editor -> Autocompletion" and "Editor -> Calltips" pages.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 Remote Debugger
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
95 In order to enable the remote debugger start eric5, open the preferences
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 dialog and configure the settings on the debugger pages.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 The remote login must be possible without any further interaction (i.e.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 no password prompt). If the remote setup differs from the local one you
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 must configure the Python interpreter and the Debug Client to be used
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
101 in the Preferences dialog. eric5 includes two different versions of the
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 debug client. DebugClient.py is the traditional debugger and
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 DebugClientThreads is a multithreading variant of the debug client.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 Please copy all needed files to a place accessible through the Python path
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 of the remote machine and set the entries of the a.m. configuration tab
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 accordingly.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 Passive Debugging
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 Passive debugging mode allows the startup of the debugger from outside
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 of the IDE. The IDE waits for a connection attempt. For further details
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 see the file README-passive-debugging.txt
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 Plugin System
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
116 eric5 contains a plugin system, that is used to extend eric5's
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
117 functionality. Some plugins are part of eric5. Additional plugins
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 are available via the Internet. Please use the built in plug-in
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 repository dialog to get a list of available (official) plugins
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 and to download them. For more details about the plug-in system
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 please see the documentation area.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 Interfaces to additional software packages
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
125 At the moment eric5 provides interfaces to the following software
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 packages.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 Qt-Designer
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 This is part of the Qt distribution and is used to generate user
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 interfaces.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 Qt-Linguist
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 This is part of the Qt distribution and is used to generate translations.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 Qt-Assistant
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 This is part of the Qt distribution and may be used to display help files.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
138 Mercurial
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
139 This is a distributed version control system available from
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
140 <mercurial.selenic.com>. It is the one used by eric5 itself.
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
141
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142 Subversion
1225
254ec677c775 Updated the README with some additional install instructions.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 100
diff changeset
143 This is a version control system available from <subversion.apache.org>.
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
144 eric5 supports two different Subversion interfaces. One is using
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
145 the svn command line tool, the other is using the PySvn Python
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
146 interface <pysvn.tigris.org>. The selection is done automatically
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147 depending on the installed software. The PySvn interface is prefered.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 This automatism can be overridden an a per project basis using
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 the "User Properties" dialog.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
150
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151 coverage.py
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 This is a tool to check Python code coverage. A slightly modified
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
153 version is part of the eric5 distribution. The original version is
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 available from <www.nedbatchelder.com/code/modules/coverage.html>
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
156 tabnanny
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
157 This is a tool to check Python code for white-space related problems. It
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 is part of the standard Python installation.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
160 profile
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
161 This is part of the standard Python distribution and is used to profile
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
162 Python source code.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
163
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
164 cyclops
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
165 This is a tool to detect variable cycles which can cause the garbage
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166 collector being unable to do his job.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 Interfaces to additional software packages via plugins
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
169
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
170 Some of the interfaces provided as plugins are as follows.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 pylint
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
173 This is a tool to check the source code according to various rules.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
174 It is available from <http://www.logilab.org/projects/pylint>.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
175
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176 cx_Freeze
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
177 This is a tool for packaging Python programs. It is available from
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
178 <http://starship.python.net/crew/atuining/cx_Freeze>
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
180 Internationalization
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
181
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
182 eric5 and it's tools are prepared to show the UI in different
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183 languages, which can be configured via the preferences dialog. The Qt and
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
184 QScintilla translations are searched in the translations directory given
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
185 in the preferences dialog (Qt page). If the translations cannot be found,
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
186 some part of the MMI might show English texts even if you have selected
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
187 something else. If you are missing eric5 translations for your language
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
188 and are willing to volunteer for this work please send me an email naming
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
189 the country code and I will send you the respective Qt-Linguist file.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
190
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 Window Layout
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
192
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
193 eric5 provides different window layouts. In these layouts, the shell window
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
194 and the file browser may be embedded or be separat windows.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
195
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196 Source code documentation
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
197
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
198 eric5 has a built in source code documentation generator, which is
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199 usable via the commandline as well. For further details please see
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
200 the file README-eric5-doc.txt
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
201
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
202 License
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
203
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
204 eric5 (and the others) is released under the conditions of the GPL. See
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
205 separate license file for more details. Third party software included in
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
206 eric5 is released under their respective license and contained in the
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
207 eric5 distribution for convenience.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
208
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
209 Bugs and other reports
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
210
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
211 Please send bug reports, feature requests or contributions to eric bugs address.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
212 After the IDE is installed you can use the "Report Bug..." entry of the Help menu.
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
213 This will send a message to <eric5-bugs@die-offenbachs.de>

eric ide

mercurial