--- a/docs/README.rst Sat Sep 07 17:33:58 2019 +0200 +++ b/docs/README.rst Sat Sep 07 17:34:29 2019 +0200 @@ -16,9 +16,8 @@ 1. Installation --------------- Installing eric6 is a simple process. There are various methods available. -Please choose the one best suited to your needs and skills. eric6 may be used -with any combination of Python 3 or 2, Qt5 or Qt4 and PyQt5 or PyQt4. However, -the recommended combination is **Python3** and **PyQt5**. +Please choose the one best suited to your needs and skills. eric6 may be must +with Python 3, Qt5 and PyQt5. 1.1 Create a Python virtual environment for eric6 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -215,8 +214,9 @@ 12. Window Layout ----------------- -eric6 provides different window layouts. In these layouts, the shell window -and the file browser may be embedded or be separat windows. +eric6 provides a configurable window layout. The visibility of the various tool +panes can be configured. The position of the shell pane may be configured as +well. 13. Source code documentation ----------------------------- @@ -224,6 +224,117 @@ usable via the commandline as well. For further details please see the file README-eric6-doc.rst. +14. Included Tools +------------------ +eric6 comes with a long list of tools. These can be started via the eric6 +tray starter or directly via the commandline. They are available from within +the IDE. The included tools are (sorted alphabetically): + + * **eric6_api.py** + + This is the tool to generate API files from Python source code. + + * **eric6_browser.py** + + This is the eric6 web browser. It is a full blown browser based on + QtWebEngine, which is based on the Chromium web engine. + + * **eric6_compare.py** + + This tool may be used to compare two files side-by-side. Differences + between the files are highlighted by coloring the text. + + * **eric6_configure.py** + + This is the standalone variant of the configuration dialog. It offers + most of the configuration options as are available from within eric6. + + * **eric6_diff.py** + + This tool may be used to view the differences between two files. These + are shown as a unified or context diff. + + * **eric6_doc.py** + + This is the tool to extract source code documentation from source files + and format that as HTML files. + + * **eric6_editor.py** + + This is a stripped down, standalone variant of the editor embedded in the + eric6 IDE. + + * **eric6_hexeditor.py** + + This is a standalone hex editor to work with binary files. + + * **eric6_iconeditor.py** + + This is a little tool to create pixel based icons and save them in a + pixmap format. + + * **eric6_plugininstall.py** + + This is a standalone utility to install eric6 plug-ins available on the + local machine. + + * **eric6_pluginrepository.py** + + This is a standalone variant of the plug-in repository window. It is used + to view the available plug-ins and download them to the local machine. + + * **eric6_pluginuninstall.py** + + This is a standalone utility to uninstall eric6 plug-ins. + + * **eric6_qregexp.py** + + This tool may be used to create regular expressions based on QRegExp. + + * **eric6_qregularexpression.py** + + This tool may be used to create regular expressions based on + QRegularExpression. + + * **eric6_re.py** + + This tool may be used to create Python regular expressions as used with the + re module. + + * **eric6_shell.py** + + This is a standalone, graphical Python shell application. + + * **eric6_snap.py** + + This tool may be used to create screenshots of the whole screen, individual + windows or selectable areas. + + * **eric6_sqlbrowser.py** + + This is a simple tool to inspect SQL databases. All database products + supported by Qt may be inspected. Note, that Qt database drivers may be + installed first. + + * **eric6_tray.py** + + This is the tray starter application. See above for some details. + + * **eric6_trpreviewer** + + This tool may be used to preview translations of Qt forms. Forms and + language files may be loaded separately. Multiple languages can be loaded + and the active language can be switched between the loaded ones. + + * **eric6_uipreviewer** + + This tool is used to preview Qt forms. The display may be switched between + the available Qt window styles. + + * **eric6_unittest** + + This is a standalone tool to execute existing unit tests. + 14. License ----------- eric6 (and the others) is released under the conditions of the GPLv3. See