docs/README.rst

Sat, 27 Apr 2019 19:43:32 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 27 Apr 2019 19:43:32 +0200
changeset 6976
66913de629f6
parent 6958
949c3c76cc8a
child 7037
4560e7a43588
permissions
-rw-r--r--

Regenerated source docu.

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
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
5 0. What is eric6?
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
6 -----------------
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
7 eric6 is a full featured Python editor and IDE, written in Python. It is based
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
8 on the cross platform Qt UI toolkit, integrating the highly flexible Scintilla
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
9 editor control. It is designed to be usable as everdays' quick and dirty editor
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
10 as well as being usable as a professional project management tool integrating
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
11 many advanced features Python offers the professional coder. eric6 includes a
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
12 plug-in system, which allows easy extension of the IDE functionality with
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
13 plug-ins downloadable from the net. For more details see
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
14 <https://eric-ide.python-projects.org>.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
15
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
16 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
17 ---------------
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
18 Installing eric6 is a simple process. There are various methods available.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
19 Please choose the one best suited to your needs and skills. eric6 may be used
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
20 with any combination of Python 3 or 2, Qt5 or Qt4 and PyQt5 or PyQt4. However,
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
21 the recommended combination is **Python3** and **PyQt5**.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
22
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
23 1.1 Create a Python virtual environment for eric6
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
25 It is recommended to install eric6 into a Python virtual environment in order
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
26 to keep your Python distribution clean. In order to do that create it by
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
27 entering the following command in a terminal window::
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
28
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
29 python3 -m venv eric6_venv
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
30
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
31 Replace ``eric6_venv`` with the desired path to the directory for the virtual
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
32 environment. All further instructions will assume this environment name.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
33
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
34 1.2a Variant 1: Installation via the "install.py" script
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
36 This method results in the most complete install on all supported platforms.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
37 After extracting the eric6 distribution archive just execute the following
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
38 command in a terminal window::
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
39
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
40 ~/eric6_venv/bin/python3 install.py
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
41
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
42 Change the path to the Python executable appropriately. The installation script
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
43 will check for all pre-requisites and will ask for confirmation to install
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
44 them. If the installation process needs tuning type
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
45 ``~/eric6_venv/bin/python3 install.py --help`` for some help.
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
46
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
47 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
48 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
49 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
50 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
51
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
52 1.2b Variant 2: Installation via the Python Package Index PyPI
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
54 This method is the easiest one but does not create a macOS® Application. Enter
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
55 the following command in a terminal window::
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
56
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
57 ~/eric6_venv/bin/python3 -m pip install eric6
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
58
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
59 Once the installation is finished navigate to the executable directory of
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
60 the Python virtual environment and execute the ``eric6_post_install`` script.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
61 This will create application menu entries on Linux and desktop and start menu
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
62 entries on Windows® platforms.
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
63
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
64 1.3 Installation of Qt Tools via Qt online installer
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
65 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
66 In order to get the most out of eric6 it is recommended to install the Qt Tools
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
67 like ``Qt Designer`` or ``Qt Linguist``. The recommended way is this.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
68
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
69 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
70
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
71 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
72
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
73 3. Configure the path to the Qt tools on the ``Qt`` configuration page of the
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
74 eric6 configuration dialog.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
75
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
76 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
77 -------------------------------
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
78 The default distribution archive of eric6 includes all supported translations
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
79 already. If the above installation variant 1 was performed with this, you may
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
80 skip this section.
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
81
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
82 If the ``nolang`` archive was used, translations may be added later on by
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
83 downloading the desired language pack, extract it to a temporary directory
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
84 and execute the install-i18n.py script (type
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
85 ``~/eric6_venv/bin/python3 install-i18n.py``).
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
86
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
87 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
88 ----------
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
89 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
90 (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
91 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
92 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
93 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
94 eric6. The web browser can be started as a standalone program by executing the
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
95 eric6_browser 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
96
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 Please note, the first time you start eric6 it will recognize, that it
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
98 hasn't been configured yet, and will show the configuration dialog.
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
99 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
100 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
101
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 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
103 ---------------------------
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 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
105 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
106 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
107 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
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 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
110 ---------------
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
111 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
112 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
113 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
114
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
115 6. Completions/Calltips
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
116 -----------------------
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
117 eric6 provides an interface to the QScintilla completion and calltips
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 functionality. QScintilla2 comes with API files for Python and itself. PyQt4
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
119 and PyQt5 contain API files as well. These are installed by default. An API
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
120 file for eric6 is installed in the same place, if installation variant 1 was
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
121 chosen.
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
122
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
123 In order to use completions and calltips in eric6 please configure these
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
124 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
125 "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
126
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
127 Additional completions and calltip providers are available through the eric6
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
128 plug-in system. See below for details.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
129
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
130 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
131 ------------------
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 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
133 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
134
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 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
136 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
137 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
138 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
139 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
140 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
141
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
142 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
143 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
144
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
145 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
146 --------------------
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 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
148 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
149 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
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 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
152 -----------------
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 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
154 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
155 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
156 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
157 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
158 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
159
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 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
161 ----------------------------------------------
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
162 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
163 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
164
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 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
166 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
167 interfaces.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168
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
169 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
170 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
171 translations.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172
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
173 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
174 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
175 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
176
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 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
178 This is a distributed version control system available from
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
179 <https://www.mercurial-scm.org/>. It is the one used by eric6 itself.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
180
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
181 Git
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
182 This is another (and probably more widely known) distributed version
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
183 control system. It is available from <https://www.git-scm.com>.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
184
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
185 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
186 This is a version control system available from
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
187 <https://subversion.apache.org>. eric6 supports two different
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
188 Subversion interfaces. One is using the svn command line tool, the
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
189 other is using the PySvn Python interface
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
190 <https://pysvn.sourceforge.io/>. The selection is done automatically
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
191 depending on the installed software. The PySvn interface is preferred.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
192 This automatism can be overridden an a per project basis using the
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
193 "User Properties" dialog.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
194
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
195 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
196 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
197 version is part of the eric6 distribution. The original version is
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
198 available from
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
199 <http://www.nedbatchelder.com/code/modules/coverage.html>
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
200
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
201 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
202 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
203 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
204
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 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
206 ------------------------
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 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
208 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
209 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
210 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
211 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
212 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
213 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
214 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
215
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 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
217 -----------------
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 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
219 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
220
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 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
222 -----------------------------
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 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
224 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
225 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
226
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 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
228 -----------
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
229 eric6 (and the others) is released under the conditions of the GPLv3. See
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
230 separate license file ``LICENSE.GPL3`` for more details. Third party software
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
231 included in eric6 is released under their respective license and contained in
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
232 the eric6 distribution for convenience.
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
233
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 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
235 --------------------------
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 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
237 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
238 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
239 <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
240 "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
241 <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
242
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
243 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
244 <https://die-offenbachs.homelinux.org/issues/>.

eric ide

mercurial