docs/README.rst

Sat, 15 Jan 2022 17:15:24 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 15 Jan 2022 17:15:24 +0100
branch
eric7
changeset 8921
8459c7e1b904
parent 8804
bf6eff477756
permissions
-rw-r--r--

Debug Client
- fixed an issue handling string arguments for subprocess.run() on Windows platforms (handling of "")

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 ========================
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
2 README for the eric7 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
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
5 0. What is eric7?
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
6 -----------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
7 eric7 is a full featured Python editor and IDE, written in Python. It is based
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
8 on the cross platform Qt UI toolkit, integrating the highly flexible Scintilla
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
9 editor control. It is designed to be usable as everyday quick and dirty editor
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
10 as well as being usable as a professional project management tool integrating
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
11 many advanced features Python offers the professional coder. eric7 includes a
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
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 ---------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
18 Installing eric7 is a simple process. There are various methods available.
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
19 Please choose the one best suited to your needs and skills. eric7 may be must
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
20 with Python 3, Qt5 and PyQt5.
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
21
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
22 1.1 Create a Python virtual environment for eric7
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
23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
24 It is recommended to install eric7 into a Python virtual environment in order
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
25 to keep your Python distribution clean. In order to do that create it by
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
26 entering the following command in a terminal window.
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
27
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
28 **Linux, macOS**::
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
29
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
30 python3 -m venv eric7_venv
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
31
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
32 **Windows**::
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
33
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
34 python.exe -m venv eric7_venv
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
35
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
36 Replace ``eric7_venv`` with the desired path to the directory for the virtual
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
37 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
38
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 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
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 This method results in the most complete install on all supported platforms.
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
42 After extracting the eric7 distribution archive just execute the following
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
43 command in a terminal window.
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
44
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
45 **Linux, macOS**::
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
46
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
47 ~/eric7_venv/bin/python3 install.py
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
48
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
49 **Windows**::
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
50
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
51 eric7_venv\Scripts\python.exe install.py
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
52
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
53 Change the path to the Python executable appropriately. The installation script
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
54 will check for all prerequisites and will ask for confirmation to install
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
55 them. If the installation process needs tuning type
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
56 ``~/eric7_venv/bin/python3 install.py --help`` for some help. Using the
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
57 ``--yes`` option answers yes to all questions automatically.
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
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
59 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
60 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
61 below mentioned address and tell me your reason. This might give me a hint on
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
62 how to improve eric7.
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
63
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
64 During the installation process a file containing some information about the
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
65 installation will be created. If this is not desired, the ``--no-info``
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
66 command line option may be added to the above given install command.
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
67
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
68 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
69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
70 This method is the easiest one but does not create a macOS® Application. Enter
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
71 the following command in a terminal window.
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
72
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
73 **Linux, macOS**::
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
74
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
75 ~/eric7_venv/bin/python3 -m pip install --upgrade eric-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
76
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
77 **Windows**::
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
78
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
79 eric7_venv\Scripts\python.exe -m pip install --upgrade eric-ide
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
80
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
81 Once the installation is finished navigate to the executable directory of
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
82 the Python virtual environment and execute the ``eric7_post_install`` script.
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
83 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
84 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
85
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
86 **Linux**::
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
87
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
88 ~/eric7_venv/bin/eric7_post_install
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
89
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
90 **Windows**::
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
91
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
92 eric7_venv\Scripts\eric7_post_install.exe
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
93
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
94 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
95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
96 In order to get the most out of eric7 it is recommended to install the Qt Tools
8567
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
97 like ``Qt Designer`` or ``Qt Linguist``. If the above shown installation
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
98 variants are executed, these tools will be installed automatically. Otherwise
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
99 it is recommended to get them from th Qt web site by following these steps.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
100
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
101 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
102
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
103 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
104
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
105 3. Configure the path to the Qt tools on the ``Qt`` configuration page of the
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
106 eric7 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
107
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
108 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
109 -------------------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
110 The default distribution archive of eric7 includes all supported translations
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
111 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
112 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
113
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
114 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
115 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
116 and execute the install-i18n.py script (type
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
117 ``~/eric7_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
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 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
120 ----------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
121 Just call up eric7, which will start the IDE. Use the "what is"-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
122 (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
123 documents describing certain aspects of eric. To start the unit test module in
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
124 a standalone variant simply call up eric7_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
125 dialog (though with a little bit less functionality) as if started from within
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
126 eric7. The web browser can be started as a standalone program by executing the
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
127 eric7_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
128
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
129 Please note, the first time you start eric7 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
130 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
131 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
132 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
133
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
134 4. Using eric on devices with small displays
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
135 --------------------------------------------
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
136 eric can be used on devices with displays smaller than full HD as well
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
137 (i.e. smaller than 1920 x 1080 pixels). If such a small screen is detected,
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
138 the interface using sidebars with just the left sidebar is chosen
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
139 automatically. This cannot be changed. If the auto-detection fails, use of
8804
bf6eff477756 Corrected a type in README.rst.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8728
diff changeset
140 the small screen layout can be forced by starting eric with the
bf6eff477756 Corrected a type in README.rst.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8728
diff changeset
141 '--small-screen' command line option. This changes the respective settings
bf6eff477756 Corrected a type in README.rst.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8728
diff changeset
142 available via the Interface ⇨ Interface configuration page (options 'Layout'
bf6eff477756 Corrected a type in README.rst.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8728
diff changeset
143 and 'Combine left and right sidebar'.
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
144
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
145 5. Running from the sources
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
146 ---------------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
147 If you want to run eric7 from within the source tree you have to execute
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
148 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
149 repository or when new dialogs have been added. Thereafter just execute
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
150 the ``eric7.py`` 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
151
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
152 6. Tray starter
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
153 ---------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
154 eric7 comes with a little utility called "eric7_tray". This embeds an icon
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
155 in the system tray, which contains a context menu to start eric7 and all
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
156 it's utilities. Double clicking this icon starts the eric7 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
157
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
158 7. Completions/Calltips
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
159 -----------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
160 eric7 provides an interface to the QScintilla completion and call-tips
8567
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
161 functionality. QScintilla2 comes with API files for Python and itself. PyQt6
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
162 and PyQt5 contain API files as well. These are installed by default. An API
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
163 file for eric7 is installed in the same place, if installation variant 1 was
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
164 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
165
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
166 In order to use completions and call-tips in eric7 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
167 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
168 "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
169
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
170 Additional completions and call-tip providers are available through the eric7
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
171 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
172
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
173 8. Remote Debugger
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
174 ------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
175 In order to enable the remote debugger start eric7, open the preferences
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
176 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
177
17c215c416ba 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 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
179 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
180 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
181 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
182 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
183 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
184
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
185 To ease the installation process of the debug client, the eric7 sources
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
186 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
187
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
188 9. Passive Debugging
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
189 --------------------
17c215c416ba 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 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
191 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
192 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
193
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
194 10. Plug-in System
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
195 ------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
196 eric7 contains a plug-in system, that is used to extend eric7's
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
197 functionality. Some plug-ins are part of eric7. Additional plugins
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
198 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
199 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
200 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
201 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
202
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
203 11. Interfaces to additional software packages
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
204 ----------------------------------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
205 At the moment eric7 provides interfaces to the following software
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
206 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
207
17c215c416ba 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 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
209 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
210 interfaces.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
211
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
212 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
213 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
214 translations.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
215
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
216 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
217 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
218 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
219
17c215c416ba 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 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
221 This is a distributed version control system available from
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
222 <https://www.mercurial-scm.org/>. It is the one used by eric7 itself.
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
223
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
224 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
225 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
226 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
227
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
228 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
229 This is a version control system available from
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
230 <https://subversion.apache.org>. eric7 supports two different
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
231 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
232 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
233 <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
234 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
235 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
236 "User Properties" dialog.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
237
8567
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
238 pip
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
239 This is a tool to install additional Python packages from the Python
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
240 Package Index (PyPI). It is available from
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
241 <https://pypi.org/project/pip/>
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
242
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
243 conda
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
244 This is another tool to install additional Python packages and manage
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
245 virtual environments. It is available from
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
246 <https://github.com/conda/conda> or <https://pypi.org/project/conda/>
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
247
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
248 virtualenv
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
249 This is a tool to create Python virtual environments. It is available
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
250 from <https://pypi.org/project/virtualenv/>
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
251
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
252 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
253 This is a tool to check Python code coverage. A slightly modified
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
254 version is part of the eric7 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
255 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
256 <http://www.nedbatchelder.com/code/modules/coverage.html>
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
257
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
258 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
259 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
260 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
261
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
262 12. Internationalization
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
263 ------------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
264 eric7 and its tools are prepared to show the UI in different languages, which
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
265 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
266 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
267 preferences dialog (Qt page). If the translations cannot be found, some part
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
268 of the HMI might show English texts even if you have selected something else.
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
269 If you are missing eric7 translations for your language and are willing to
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
270 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
271 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
272
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
273 13. Window Layout
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
274 -----------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
275 eric7 provides a configurable window layout. The visibility of the various tool
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
276 panes can be configured. The position of the shell pane may be configured as
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
277 well.
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
278
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
279 14. Source code documentation
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
280 -----------------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
281 eric7 has a built in source code documentation generator, which is
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
282 usable via the command line as well. For further details please see
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
283 the file README-eric7-doc.rst.
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
284
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
285 15. Included Tools
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
286 ------------------
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
287 eric7 comes with a long list of tools. These can be started via the eric7
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
288 tray starter or directly via the command line. They are available from within
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
289 the IDE. The included tools are (sorted alphabetically):
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
290
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
291 * **eric7_api.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
292
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
293 This is the tool to generate API files from Python source code.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
294
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
295 * **eric7_browser.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
296
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
297 This is the eric7 web browser. It is a full blown browser based on
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
298 QtWebEngine, which is based on the Chromium web engine.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
299
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
300 * **eric7_compare.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
301
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
302 This tool may be used to compare two files side-by-side. Differences
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
303 between the files are highlighted by coloring the text.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
304
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
305 * **eric7_configure.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
306
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
307 This is the standalone variant of the configuration dialog. It offers
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
308 most of the configuration options as are available from within eric7.
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
309
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
310 * **eric7_diff.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
311
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
312 This tool may be used to view the differences between two files. These
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
313 are shown as a unified or context diff.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
314
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
315 * **eric7_doc.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
316
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
317 This is the tool to extract source code documentation from source files
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
318 and format that as HTML files.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
319
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
320 * **eric7_editor.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
321
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
322 This is a stripped down, standalone variant of the editor embedded in the
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
323 eric7 IDE.
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
324
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
325 * **eric7_hexeditor.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
326
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
327 This is a standalone hex editor to work with binary files.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
328
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
329 * **eric7_iconeditor.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
330
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
331 This is a little tool to create pixel based icons and save them in a
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
332 pixmap format.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
333
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
334 * **eric7_plugininstall.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
335
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
336 This is a standalone utility to install eric7 plug-ins available on the
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
337 local machine.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
338
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
339 * **eric7_pluginrepository.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
340
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
341 This is a standalone variant of the plug-in repository window. It is used
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
342 to view the available plug-ins and download them to the local machine.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
343
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
344 * **eric7_pluginuninstall.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
345
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
346 This is a standalone utility to uninstall eric7 plug-ins.
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
347
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
348 * **eric7_qregularexpression.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
349
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
350 This tool may be used to create regular expressions based on
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
351 QRegularExpression.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
352
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
353 * **eric7_re.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
354
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
355 This tool may be used to create Python regular expressions as used with the
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
356 re module.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
357
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
358 * **eric7_shell.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
359
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
360 This is a standalone, graphical Python shell application.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
361
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
362 * **eric7_snap.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
363
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
364 This tool may be used to create screenshots of the whole screen, individual
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
365 windows or selectable areas.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
366
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
367 * **eric7_sqlbrowser.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
368
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
369 This is a simple tool to inspect SQL databases. All database products
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
370 supported by Qt may be inspected. Note, that Qt database drivers may be
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
371 installed first.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
372
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
373 * **eric7_tray.py**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
374
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
375 This is the tray starter application. See above for some details.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
376
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
377 * **eric7_trpreviewer**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
378
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
379 This tool may be used to preview translations of Qt forms. Forms and
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
380 language files may be loaded separately. Multiple languages can be loaded
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
381 and the active language can be switched between the loaded ones.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
382
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
383 * **eric7_uipreviewer**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
384
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
385 This tool is used to preview Qt forms. The display may be switched between
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
386 the available Qt window styles.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
387
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
388 * **eric7_unittest**
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
389
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
390 This is a standalone tool to execute existing unit tests.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
391
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
392 * **eric7_virtualenv**
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
393
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
394 This is a standalone tool to manage Python virtual environments. It is
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
395 like the integrated pane and offers the same functionality.
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
396
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
397 16. License
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
398 -----------
8567
a9ec6702c664 Fine tuned the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8477
diff changeset
399 eric7 (and the eric7 tools) is released under the conditions of the GPLv3. See
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
400 separate license file ``LICENSE.GPL3`` for more details. Third party software
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
401 included in eric7 is released under their respective license and contained in
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
402 the eric7 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
403
8728
62b44a7c0a3a Introduced the command line option '--small-screen' and a small screen detection method to choose the interface layout suitable for screen small than full HD. Added a section to the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 8567
diff changeset
404 17. Bugs and other reports
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
405 --------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
406 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
407 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
408 entry of the Help menu, which will send an email to
7037
4560e7a43588 README.rst: Fixed some issues in the text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6958
diff changeset
409 <eric-bugs@eric-ide.python-projects.org>. To request a new feature use the
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
410 "Request Feature..." entry of the Help menu, which will send an email to
7037
4560e7a43588 README.rst: Fixed some issues in the text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6958
diff changeset
411 <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
412
8477
81e25fe19818 Updated the documentation contained in the 'docs' folder.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7929
diff changeset
413 Alternatively bugs may be reported via the eric7 issue tracker at
7929
fdd769e06482 README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7222
diff changeset
414 <https://tracker.die-offenbachs.homelinux.org/>.

eric ide

mercurial