docs/README.rst

Fri, 19 Apr 2019 17:48:40 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 19 Apr 2019 17:48:40 +0200
changeset 6956
dfd3b53be436
parent 6942
2602857055c5
child 6958
949c3c76cc8a
permissions
-rw-r--r--

install: change minimum version of QScintilla to 2.9.0.

4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
1 ========================
3682
2543741b47b7 Changed a few files to reference eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1225
diff changeset
2 README for the eric6 IDE
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
3 ========================
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
4
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
5 1. Installation
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
6 ---------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
7 Installing eric6 is a simple process. Just execute the ``install.py`` script
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
8 (type ``python install.py -h`` for some help). Please note that the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
9 installation has to be performed using the administrators account (i.e. root
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
10 on linux). This installs a wrapper script called eric6 in the standard
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
11 executable directory.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
12
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
13 If you want to uninstall the package just execute the ``uninstall.py`` script.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
14 This gets rid of all installed files. In this case please send an email to the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
15 below mentioned address and tell me your reason. This might give me a hint on
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
16 how to improve eric6.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
17
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
18 eric6 may be used with any combination of Python 3 or 2, Qt5 or Qt4 and
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
19 PyQt5 or PyQt4. If the required packages (Qt5/4, QScintilla2, sip and PyQt5/4)
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
20 are not installed, please get them and install them in the following order
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
21 (order is important).
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
22
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
23 1. Install Qt5 (from The Qt Company)
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
24
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
25 2. Build and install QScintilla2 (from Riverbank Computing)
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
26
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
27 3. Build and install sip (from Riverbank Computing)
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
28
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
29 4. Build and install PyQt5 (from Riverbank Computing)
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
30
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
31 5. Build and install QScintilla2 Python bindings
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
32 (part of the QScintilla2 package)
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
33
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
34 6. Install eric6
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
35
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
36 If you want to use the interfaces to other supported software packages, you may
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
37 install them in any order and at any time.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
38
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
39 Please note, that the QScintilla2 Python bindings have to be rebuild, if
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
40 the PyQt5 package gets updated. If this step is omitted, a bunch of strange
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
41 errors will occur.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
42
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
43 1.1 Installation on Windows®
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
44 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5152
e685f2398a95 Fixed an issue in listspace.py causing a traceback when shutting down with an externally modified file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5079
diff changeset
45 **Note:** This section is valid for PyQt4 and PyQt5 before 5.7.0.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
46
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
47 Installing eric6 on Windows® is even easier. Just download the PyQt5
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
48 installer from Riverbank Computing and use it to install PyQt5. This includes
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
49 all the required Qt5 libraries and tools as well as QScintilla. Once
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
50 this installation is completed install eric6. That's all.
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
51
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
52 1.2 Installation using PyQt5 wheels
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
54 **Note:** This section is valid for PyQt5 5.7.0 or newer.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
55
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
56 Installing eric6 and its pre-requisites is even easier using the PyQt5 Python
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
57 wheels. In order to have access to the suite of Qt tools and documentation it
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
58 is recommended to install the Qt development environment. These tools are not
5735
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
59 part of the PyQt5 wheels. Users of the Windows® operating system may use the
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
60 'pyqt5-tools' wheel available via the Python Package Index (PyPI) as of
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
61 2017-05-12.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
62
5735
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
63 1.2.1 Installation of Qt Tools via Qt online installer
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
64 ======================================================
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
65 1. Download the Qt online installer from the Qt download site.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
66
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
67 2. Install Qt by executing the installer.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
68
5735
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
69 1.2.2 Installation of Qt Tools via PyPI
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
70 =======================================
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
71 1. Install the Qt tools by entering this command in a command window::
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
72
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
73 pip install pyqt5-tools
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
74
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
75 1.2.3 Installation of PyQt5 and eric
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
76 ====================================
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
77 1. Install the eric6 pre-requisites (PyQt, sip and QScintilla) by entering
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
78 this command in a shell / command window::
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
79
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
80 pip install qscintilla
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
81
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
82 or ::
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
83
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
84 pip3 install qscintilla
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
85
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
86 This will install QScintilla and all dependencies, which are PyQt5 and sip.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
87
5735
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
88 2. Install eric6 and configure the path to the Qt tools on the Qt page of the
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
89 configuration dialog.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
90
5735
f606dbe20be6 Added code to auto-discover the presence of the new 'pyqt5-tools' wheel (Windows only).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5422
diff changeset
91 3. Once the eric6 IDE is started the Qt documentation may be loaded into the
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
92 eric web browser via the ``Settings ➡ Mange Qt Help Documents`` menu entry.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
93
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
94 2. Installation of translations
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
95 -------------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
96 Translations of the eric6 IDE are available as separate downloads. There
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
97 are two ways to install them.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
98
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
99 The first possibility is to install them together with eric6. In order
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
100 to do that, simply extract the downloaded archives into the same place
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
101 as the eric6 archive and follow the installation instructions above.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
102
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
103 The second possibility is to install them separately. Extract the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
104 downloaded archives and execute the install-i18n.py script (type
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
105 ``python install-i18n.py -h`` for some help). This way you can make the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
106 translations available to everybody or just to the user executing the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
107 installation command (if using the -p switch).
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
108
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
109 3. Running
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
110 ----------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
111 Just call up eric6, which will start the IDE. Use the "what is"-help
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
112 (arrow with ?) to get some help. The eric web site provides some
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
113 documents describing certain aspects of eric. To start the unit test module in
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
114 a standalone variant simply call up eric6_unittest. This will show the same
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
115 dialog (though with a little bit less functionality) as if started from within
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
116 eric6. The web browser can be started as a standalone program by executing the
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
117 eric6_webbrowser script.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
118
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
119 Please note, the first time you start eric6 it will recognize, that it
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
120 hasn't been configured yet and will show the configuration dialog.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
121 Please take your time and go through all the configuration items.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
122 However, every configuration option has a meaningful default value.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
123
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
124 4. Running from the sources
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
125 ---------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
126 If you want to run eric6 from within the source tree you have to execute
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
127 the ``compileUiFiles.py`` script once after a fresh checkout from the source
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
128 repository or when new dialogs have been added. Thereafter just execute
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
129 the ``eric6.py`` script.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
130
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
131 5. Tray starter
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
132 ---------------
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
133 eric6 comes with a little utility called "eric6_tray". This embeds an icon
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
134 in the system tray, which contains a context menu to start eric6 and all
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
135 it's utilities. Double clicking this icon starts the eric6 IDE.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
136
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
137 6. Autocompletion/Calltips
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
138 --------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
139 eric6 provides an interface to the QScintilla auto-completion and calltips
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
140 functionality. QScintilla2 comes with API files for Python and itself. PyQt4
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
141 and PyQt5 contain API files as well. These are installed by default, if the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
142 correct installation order (see above) is followed. An API file for eric6 is
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
143 installed in the same place.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
144
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
145 In order to use autocompletion and calltips in eric6 please configure these
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
146 functions in the "Preferences Dialog" on the "Editor -> APIs",
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
147 "Editor -> Autocompletion" and "Editor -> Calltips" pages.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
148
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
149 7. Remote Debugger
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
150 ------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
151 In order to enable the remote debugger start eric6, open the preferences
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
152 dialog and configure the settings on the debugger pages.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
153
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
154 The remote login must be possible without any further interaction (i.e.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
155 no password prompt). If the remote setup differs from the local one you
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
156 must configure the Python interpreter and the Debug Client to be used
5422
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5403
diff changeset
157 in the Preferences dialog. Use the ``install-debugclients.py`` script
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5403
diff changeset
158 to install the debug client files and set the entries of the a.m.
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5403
diff changeset
159 configuration page accordingly.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
160
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
161 To ease the installation process of the debug client, the eric6 sources
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
162 include the script ``install-debugclients.py``.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
163
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
164 8. Passive Debugging
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
165 --------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
166 Passive debugging mode allows the startup of the debugger from outside
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
167 of the IDE. The IDE waits for a connection attempt. For further details
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
168 see the file README-passive-debugging.rst.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
169
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
170 9. Plug-in System
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
171 -----------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
172 eric6 contains a plug-in system, that is used to extend eric6's
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
173 functionality. Some plug-ins are part of eric6. Additional plugins
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
174 are available via the Internet. Please use the built-in plug-in
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
175 repository dialog to get a list of available (official) plug-ins
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
176 and to download them. For more details about the plug-in system
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
177 please see the documentation area.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
178
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
179 10. Interfaces to additional software packages
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
180 ----------------------------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
181 At the moment eric6 provides interfaces to the following software
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
182 packages.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
183
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
184 Qt-Designer
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
185 This is part of the Qt distribution and is used to generate user
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
186 interfaces.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
187
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
188 Qt-Linguist
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
189 This is part of the Qt distribution and is used to generate
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
190 translations.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
192 Qt-Assistant
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
193 This is part of the Qt distribution and may be used to display help
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
194 files.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
195
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
196 Mercurial
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
197 This is a distributed version control system available from
5403
d6b43ecf2488 Corrected the link to the Mercurial web site in some README files.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5375
diff changeset
198 <http://www.mercurial-scm.org>. It is the one used by eric6 itself.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
200 Subversion
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
201 This is a version control system available from
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
202 <http://subversion.apache.org>. eric6 supports two different Subversion
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
203 interfaces. One is using the svn command line tool, the other is using
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
204 the PySvn Python interface <pysvn.tigris.org>. The selection is done
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
205 automatically depending on the installed software. The PySvn interface
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
206 is prefered. This automatism can be overridden an a per project basis
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
207 using the "User Properties" dialog.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
208
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
209 coverage.py
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
210 This is a tool to check Python code coverage. A slightly modified
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
211 version is part of the eric6 distribution. The original version is
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
212 available from <http://www.nedbatchelder.com/code/modules/coverage.html>
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
213
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
214 tabnanny
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
215 This is a tool to check Python code for white-space related problems.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
216 It is part of the standard Python installation.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
217
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
218 profile
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
219 This is part of the standard Python distribution and is used to profile
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
220 Python source code.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
221
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
222 11. Internationalization
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
223 ------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
224 eric6 and its tools are prepared to show the UI in different languages, which
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
225 can be configured via the preferences dialog. The Qt and QScintilla
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
226 translations are searched in the translations directory given in the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
227 preferences dialog (Qt page). If the translations cannot be found, some part
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
228 of the MMI might show English texts even if you have selected something else.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
229 If you are missing eric6 translations for your language and are willing to
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
230 volunteer for this work please send me an email naming the country code and
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
231 I will send you the respective Qt-Linguist file.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
232
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
233 12. Window Layout
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
234 -----------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
235 eric6 provides different window layouts. In these layouts, the shell window
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
236 and the file browser may be embedded or be separat windows.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
237
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
238 13. Source code documentation
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
239 -----------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
240 eric6 has a built in source code documentation generator, which is
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
241 usable via the commandline as well. For further details please see
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
242 the file README-eric6-doc.rst.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
243
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
244 14. License
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
245 -----------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
246 eric6 (and the others) is released under the conditions of the GPL. See
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
247 separate license file for more details. Third party software included in
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
248 eric6 is released under their respective license and contained in the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
249 eric6 distribution for convenience.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
250
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
251 15. Bugs and other reports
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
252 --------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
253 Please send bug reports, feature requests or contributions to eric bugs
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
254 address. After the IDE is installed you can use the "Report Bug..."
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
255 entry of the Help menu, which will send an email to
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
256 <eric-bugs@eric-ide.python-projects.org. To request a new feature use the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
257 "Request Feature..." entry of the Help menu, which will send an email to
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
258 <eric-featurerequest@eric-ide.python-projects.org.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
259
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
260 Alternatively bugs may be reported via the eric6 issue tracker at
5375
c55d7340ef39 Changed references to the eric web site URL to use the secure protocol https://.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5152
diff changeset
261 <https://die-offenbachs.homelinux.org/issues/>.

eric ide

mercurial