Mercurial Repositories > eric / changeset
changeset
README: updated the installation section to show the commands for Linux/macOS and Windows separately.
Wed, 30 Dec 2020 18:24:42 +0100
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Wed, 30 Dec 2020 18:24:42 +0100
- branch
- maintenance
- changeset 7930
- 4949ce4c4640
- parent 7924
- 8a96736d465e
- child 7934
- e59e5f279676
README: updated the installation section to show the commands for Linux/macOS and Windows separately.
(grafted from fdd769e06482ec6a43e6133b5b9c23e9e0e56a56)
| docs/README.rst | file | annotate | diff | comparison | revisions |
--- a/docs/README.rst Wed Dec 30 11:00:44 2020 +0100 +++ b/docs/README.rst Wed Dec 30 18:24:42 2020 +0100 @@ -6,7 +6,7 @@ ----------------- eric6 is a full featured Python editor and IDE, written in Python. It is based on the cross platform Qt UI toolkit, integrating the highly flexible Scintilla -editor control. It is designed to be usable as everdays' quick and dirty editor +editor control. It is designed to be usable as everyday quick and dirty editor as well as being usable as a professional project management tool integrating many advanced features Python offers the professional coder. eric6 includes a plug-in system, which allows easy extension of the IDE functionality with @@ -23,10 +23,16 @@ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ It is recommended to install eric6 into a Python virtual environment in order to keep your Python distribution clean. In order to do that create it by -entering the following command in a terminal window:: +entering the following command in a terminal window. + +**Linux, macOS**:: python3 -m venv eric6_venv +**Windows**:: + + python.exe -m venv eric6_venv + Replace ``eric6_venv`` with the desired path to the directory for the virtual environment. All further instructions will assume this environment name. @@ -34,32 +40,57 @@ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This method results in the most complete install on all supported platforms. After extracting the eric6 distribution archive just execute the following -command in a terminal window:: +command in a terminal window. + +**Linux, macOS**:: ~/eric6_venv/bin/python3 install.py +**Windows**:: + + eric6_venv\Scripts\python.exe install.py + Change the path to the Python executable appropriately. The installation script -will check for all pre-requisites and will ask for confirmation to install +will check for all prerequisites and will ask for confirmation to install them. If the installation process needs tuning type -``~/eric6_venv/bin/python3 install.py --help`` for some help. +``~/eric6_venv/bin/python3 install.py --help`` for some help. Using the +``--yes`` option answers yes to all questions automatically. If you want to uninstall the package just execute the ``uninstall.py`` script. This gets rid of all installed files. In this case please send an email to the below mentioned address and tell me your reason. This might give me a hint on how to improve eric6. +During the installation process a file containing some information about the +installation will be created. If this is not desired, the ``--no-info`` +command line option may be added to the above given install command. + 1.2b Variant 2: Installation via the Python Package Index PyPI ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This method is the easiest one but does not create a macOS® Application. Enter -the following command in a terminal window:: +the following command in a terminal window. + +**Linux, macOS**:: ~/eric6_venv/bin/python3 -m pip install --upgrade eric-ide +**Windows**:: + + eric6_venv\Scripts\python.exe -m pip install --upgrade eric-ide + Once the installation is finished navigate to the executable directory of the Python virtual environment and execute the ``eric6_post_install`` script. This will create application menu entries on Linux and desktop and start menu entries on Windows® platforms. +**Linux**:: + + ~/eric6_venv/bin/eric6_post_install + +**Windows**:: + + eric6_venv\Scripts\eric6_post_install.exe + 1.3 Installation of Qt Tools via Qt online installer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In order to get the most out of eric6 it is recommended to install the Qt Tools @@ -113,17 +144,17 @@ 6. Completions/Calltips ----------------------- -eric6 provides an interface to the QScintilla completion and calltips +eric6 provides an interface to the QScintilla completion and call-tips functionality. QScintilla2 comes with API files for Python and itself. PyQt4 and PyQt5 contain API files as well. These are installed by default. An API file for eric6 is installed in the same place, if installation variant 1 was chosen. -In order to use completions and calltips in eric6 please configure these +In order to use completions and call-tips in eric6 please configure these functions in the "Preferences Dialog" on the "Editor -> APIs", "Editor -> Autocompletion" and "Editor -> Calltips" pages. -Additional completions and calltip providers are available through the eric6 +Additional completions and call-tip providers are available through the eric6 plug-in system. See below for details. 7. Remote Debugger @@ -207,7 +238,7 @@ can be configured via the preferences dialog. The Qt and QScintilla translations are searched in the translations directory given in the preferences dialog (Qt page). If the translations cannot be found, some part -of the MMI might show English texts even if you have selected something else. +of the HMI might show English texts even if you have selected something else. If you are missing eric6 translations for your language and are willing to volunteer for this work please send me an email naming the country code and I will send you the respective Qt-Linguist file. @@ -221,13 +252,13 @@ 13. Source code documentation ----------------------------- eric6 has a built in source code documentation generator, which is -usable via the commandline as well. For further details please see +usable via the command line 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 +tray starter or directly via the command line. They are available from within the IDE. The included tools are (sorted alphabetically): * **eric6_api.py** @@ -287,10 +318,6 @@ 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 @@ -352,4 +379,4 @@ <eric-featurerequest@eric-ide.python-projects.org>. Alternatively bugs may be reported via the eric6 issue tracker at -<https://die-offenbachs.homelinux.org/issues/>. +<https://tracker.die-offenbachs.homelinux.org/>.
