README.rst

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

eric ide

mercurial