Mercurial Repositories > eric / file comparison
comparison: docs/README.rst
docs/README.rst
- changeset 7929
- fdd769e06482
- parent 7222
- fc6530b432ad
- child 8477
- 81e25fe19818
equal
deleted
inserted
replaced
| 7928:a78ce4578fed | 7929:fdd769e06482 |
|---|---|
| 4 | 4 |
| 5 0. What is eric6? | 5 0. What is eric6? |
| 6 ----------------- | 6 ----------------- |
| 7 eric6 is a full featured Python editor and IDE, written in Python. It is based | 7 eric6 is a full featured Python editor and IDE, written in Python. It is based |
| 8 on the cross platform Qt UI toolkit, integrating the highly flexible Scintilla | 8 on the cross platform Qt UI toolkit, integrating the highly flexible Scintilla |
| 9 editor control. It is designed to be usable as everdays' quick and dirty editor | 9 editor control. It is designed to be usable as everyday quick and dirty editor |
| 10 as well as being usable as a professional project management tool integrating | 10 as well as being usable as a professional project management tool integrating |
| 11 many advanced features Python offers the professional coder. eric6 includes a | 11 many advanced features Python offers the professional coder. eric6 includes a |
| 12 plug-in system, which allows easy extension of the IDE functionality with | 12 plug-in system, which allows easy extension of the IDE functionality with |
| 13 plug-ins downloadable from the net. For more details see | 13 plug-ins downloadable from the net. For more details see |
| 14 <https://eric-ide.python-projects.org>. | 14 <https://eric-ide.python-projects.org>. |
| 21 | 21 |
| 22 1.1 Create a Python virtual environment for eric6 | 22 1.1 Create a Python virtual environment for eric6 |
| 23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 24 It is recommended to install eric6 into a Python virtual environment in order | 24 It is recommended to install eric6 into a Python virtual environment in order |
| 25 to keep your Python distribution clean. In order to do that create it by | 25 to keep your Python distribution clean. In order to do that create it by |
| 26 entering the following command in a terminal window:: | 26 entering the following command in a terminal window. |
| 27 | |
| 28 **Linux, macOS**:: | |
| 27 | 29 |
| 28 python3 -m venv eric6_venv | 30 python3 -m venv eric6_venv |
| 31 | |
| 32 **Windows**:: | |
| 33 | |
| 34 python.exe -m venv eric6_venv | |
| 29 | 35 |
| 30 Replace ``eric6_venv`` with the desired path to the directory for the virtual | 36 Replace ``eric6_venv`` with the desired path to the directory for the virtual |
| 31 environment. All further instructions will assume this environment name. | 37 environment. All further instructions will assume this environment name. |
| 32 | 38 |
| 33 1.2a Variant 1: Installation via the "install.py" script | 39 1.2a Variant 1: Installation via the "install.py" script |
| 34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 35 This method results in the most complete install on all supported platforms. | 41 This method results in the most complete install on all supported platforms. |
| 36 After extracting the eric6 distribution archive just execute the following | 42 After extracting the eric6 distribution archive just execute the following |
| 37 command in a terminal window:: | 43 command in a terminal window. |
| 44 | |
| 45 **Linux, macOS**:: | |
| 38 | 46 |
| 39 ~/eric6_venv/bin/python3 install.py | 47 ~/eric6_venv/bin/python3 install.py |
| 40 | 48 |
| 49 **Windows**:: | |
| 50 | |
| 51 eric6_venv\Scripts\python.exe install.py | |
| 52 | |
| 41 Change the path to the Python executable appropriately. The installation script | 53 Change the path to the Python executable appropriately. The installation script |
| 42 will check for all pre-requisites and will ask for confirmation to install | 54 will check for all prerequisites and will ask for confirmation to install |
| 43 them. If the installation process needs tuning type | 55 them. If the installation process needs tuning type |
| 44 ``~/eric6_venv/bin/python3 install.py --help`` for some help. | 56 ``~/eric6_venv/bin/python3 install.py --help`` for some help. Using the |
| 57 ``--yes`` option answers yes to all questions automatically. | |
| 45 | 58 |
| 46 If you want to uninstall the package just execute the ``uninstall.py`` script. | 59 If you want to uninstall the package just execute the ``uninstall.py`` script. |
| 47 This gets rid of all installed files. In this case please send an email to the | 60 This gets rid of all installed files. In this case please send an email to the |
| 48 below mentioned address and tell me your reason. This might give me a hint on | 61 below mentioned address and tell me your reason. This might give me a hint on |
| 49 how to improve eric6. | 62 how to improve eric6. |
| 50 | 63 |
| 64 During the installation process a file containing some information about the | |
| 65 installation will be created. If this is not desired, the ``--no-info`` | |
| 66 command line option may be added to the above given install command. | |
| 67 | |
| 51 1.2b Variant 2: Installation via the Python Package Index PyPI | 68 1.2b Variant 2: Installation via the Python Package Index PyPI |
| 52 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 53 This method is the easiest one but does not create a macOS® Application. Enter | 70 This method is the easiest one but does not create a macOS® Application. Enter |
| 54 the following command in a terminal window:: | 71 the following command in a terminal window. |
| 72 | |
| 73 **Linux, macOS**:: | |
| 55 | 74 |
| 56 ~/eric6_venv/bin/python3 -m pip install --upgrade eric-ide | 75 ~/eric6_venv/bin/python3 -m pip install --upgrade eric-ide |
| 76 | |
| 77 **Windows**:: | |
| 78 | |
| 79 eric6_venv\Scripts\python.exe -m pip install --upgrade eric-ide | |
| 57 | 80 |
| 58 Once the installation is finished navigate to the executable directory of | 81 Once the installation is finished navigate to the executable directory of |
| 59 the Python virtual environment and execute the ``eric6_post_install`` script. | 82 the Python virtual environment and execute the ``eric6_post_install`` script. |
| 60 This will create application menu entries on Linux and desktop and start menu | 83 This will create application menu entries on Linux and desktop and start menu |
| 61 entries on Windows® platforms. | 84 entries on Windows® platforms. |
| 85 | |
| 86 **Linux**:: | |
| 87 | |
| 88 ~/eric6_venv/bin/eric6_post_install | |
| 89 | |
| 90 **Windows**:: | |
| 91 | |
| 92 eric6_venv\Scripts\eric6_post_install.exe | |
| 62 | 93 |
| 63 1.3 Installation of Qt Tools via Qt online installer | 94 1.3 Installation of Qt Tools via Qt online installer |
| 64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 65 In order to get the most out of eric6 it is recommended to install the Qt Tools | 96 In order to get the most out of eric6 it is recommended to install the Qt Tools |
| 66 like ``Qt Designer`` or ``Qt Linguist``. The recommended way is this. | 97 like ``Qt Designer`` or ``Qt Linguist``. The recommended way is this. |
| 111 in the system tray, which contains a context menu to start eric6 and all | 142 in the system tray, which contains a context menu to start eric6 and all |
| 112 it's utilities. Double clicking this icon starts the eric6 IDE. | 143 it's utilities. Double clicking this icon starts the eric6 IDE. |
| 113 | 144 |
| 114 6. Completions/Calltips | 145 6. Completions/Calltips |
| 115 ----------------------- | 146 ----------------------- |
| 116 eric6 provides an interface to the QScintilla completion and calltips | 147 eric6 provides an interface to the QScintilla completion and call-tips |
| 117 functionality. QScintilla2 comes with API files for Python and itself. PyQt4 | 148 functionality. QScintilla2 comes with API files for Python and itself. PyQt4 |
| 118 and PyQt5 contain API files as well. These are installed by default. An API | 149 and PyQt5 contain API files as well. These are installed by default. An API |
| 119 file for eric6 is installed in the same place, if installation variant 1 was | 150 file for eric6 is installed in the same place, if installation variant 1 was |
| 120 chosen. | 151 chosen. |
| 121 | 152 |
| 122 In order to use completions and calltips in eric6 please configure these | 153 In order to use completions and call-tips in eric6 please configure these |
| 123 functions in the "Preferences Dialog" on the "Editor -> APIs", | 154 functions in the "Preferences Dialog" on the "Editor -> APIs", |
| 124 "Editor -> Autocompletion" and "Editor -> Calltips" pages. | 155 "Editor -> Autocompletion" and "Editor -> Calltips" pages. |
| 125 | 156 |
| 126 Additional completions and calltip providers are available through the eric6 | 157 Additional completions and call-tip providers are available through the eric6 |
| 127 plug-in system. See below for details. | 158 plug-in system. See below for details. |
| 128 | 159 |
| 129 7. Remote Debugger | 160 7. Remote Debugger |
| 130 ------------------ | 161 ------------------ |
| 131 In order to enable the remote debugger start eric6, open the preferences | 162 In order to enable the remote debugger start eric6, open the preferences |
| 205 ------------------------ | 236 ------------------------ |
| 206 eric6 and its tools are prepared to show the UI in different languages, which | 237 eric6 and its tools are prepared to show the UI in different languages, which |
| 207 can be configured via the preferences dialog. The Qt and QScintilla | 238 can be configured via the preferences dialog. The Qt and QScintilla |
| 208 translations are searched in the translations directory given in the | 239 translations are searched in the translations directory given in the |
| 209 preferences dialog (Qt page). If the translations cannot be found, some part | 240 preferences dialog (Qt page). If the translations cannot be found, some part |
| 210 of the MMI might show English texts even if you have selected something else. | 241 of the HMI might show English texts even if you have selected something else. |
| 211 If you are missing eric6 translations for your language and are willing to | 242 If you are missing eric6 translations for your language and are willing to |
| 212 volunteer for this work please send me an email naming the country code and | 243 volunteer for this work please send me an email naming the country code and |
| 213 I will send you the respective Qt-Linguist file. | 244 I will send you the respective Qt-Linguist file. |
| 214 | 245 |
| 215 12. Window Layout | 246 12. Window Layout |
| 219 well. | 250 well. |
| 220 | 251 |
| 221 13. Source code documentation | 252 13. Source code documentation |
| 222 ----------------------------- | 253 ----------------------------- |
| 223 eric6 has a built in source code documentation generator, which is | 254 eric6 has a built in source code documentation generator, which is |
| 224 usable via the commandline as well. For further details please see | 255 usable via the command line as well. For further details please see |
| 225 the file README-eric6-doc.rst. | 256 the file README-eric6-doc.rst. |
| 226 | 257 |
| 227 14. Included Tools | 258 14. Included Tools |
| 228 ------------------ | 259 ------------------ |
| 229 eric6 comes with a long list of tools. These can be started via the eric6 | 260 eric6 comes with a long list of tools. These can be started via the eric6 |
| 230 tray starter or directly via the commandline. They are available from within | 261 tray starter or directly via the command line. They are available from within |
| 231 the IDE. The included tools are (sorted alphabetically): | 262 the IDE. The included tools are (sorted alphabetically): |
| 232 | 263 |
| 233 * **eric6_api.py** | 264 * **eric6_api.py** |
| 234 | 265 |
| 235 This is the tool to generate API files from Python source code. | 266 This is the tool to generate API files from Python source code. |
| 284 to view the available plug-ins and download them to the local machine. | 315 to view the available plug-ins and download them to the local machine. |
| 285 | 316 |
| 286 * **eric6_pluginuninstall.py** | 317 * **eric6_pluginuninstall.py** |
| 287 | 318 |
| 288 This is a standalone utility to uninstall eric6 plug-ins. | 319 This is a standalone utility to uninstall eric6 plug-ins. |
| 289 | |
| 290 * **eric6_qregexp.py** | |
| 291 | |
| 292 This tool may be used to create regular expressions based on QRegExp. | |
| 293 | 320 |
| 294 * **eric6_qregularexpression.py** | 321 * **eric6_qregularexpression.py** |
| 295 | 322 |
| 296 This tool may be used to create regular expressions based on | 323 This tool may be used to create regular expressions based on |
| 297 QRegularExpression. | 324 QRegularExpression. |
| 350 <eric-bugs@eric-ide.python-projects.org>. To request a new feature use the | 377 <eric-bugs@eric-ide.python-projects.org>. To request a new feature use the |
| 351 "Request Feature..." entry of the Help menu, which will send an email to | 378 "Request Feature..." entry of the Help menu, which will send an email to |
| 352 <eric-featurerequest@eric-ide.python-projects.org>. | 379 <eric-featurerequest@eric-ide.python-projects.org>. |
| 353 | 380 |
| 354 Alternatively bugs may be reported via the eric6 issue tracker at | 381 Alternatively bugs may be reported via the eric6 issue tracker at |
| 355 <https://die-offenbachs.homelinux.org/issues/>. | 382 <https://tracker.die-offenbachs.homelinux.org/>. |
