README

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

eric ide

mercurial