Mercurial Repositories > eric / changeset
changeset
Some corrections to the various README files.
Mon, 25 May 2015 16:27:07 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Mon, 25 May 2015 16:27:07 +0200
- branch
- 6_0_x
- changeset 4265
- 9d69e24d0279
- parent 4264
- eb874caf019d
- child 4268
- 6f0af8933902
Some corrections to the various README files.
| README | file | annotate | diff | comparison | revisions | |
| README-MacOSX.txt | file | annotate | diff | comparison | revisions |
--- a/README Sun May 17 16:55:30 2015 +0200 +++ b/README Mon May 25 16:27:07 2015 +0200 @@ -2,44 +2,46 @@ Installation - Installing eric6 is a simple process. Just execute the install.py script - (type python install.py -h for some help). Please note that the installation - has to be performed using the administrators account (i.e. root on linux). - This installs a wrapper script in the standard executable directory called - eric6. + Installing eric6 is a simple process. Just execute the install.py + script (type python install.py -h for some help). Please note that the + installation has to be performed using the administrators account + (i.e. root on linux). This installs a wrapper script called eric6 in + the standard executable directory. - If you want to uninstall the package just execute the uninstall 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. + 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. - If the required packages (Qt5, QScintilla2, sip and PyQt5) are not installed, - please get them and install them in the following order (order is important). + eric6 may be used with any combination of Python 3 or 2, Qt5 or Qt4 and + PyQt5 or PyQt4. If the required packages (Qt5/4, QScintilla2, sip and + PyQt5/4) are not installed, please get them and install them in the + following order (order is important). - 1. Install Qt5 (from Nokia) + 1. Install Qt5 (or Qt4) (from The Qt Company) 2. Build and install QScintilla2 (from Riverbank Computing) 3. Build and install sip (from Riverbank Computing) - 4. Build and install PyQt5 (from Riverbank Computing) + 4. Build and install PyQt5 (or PyQt4) (from Riverbank Computing) 5. Build and install QScintilla2 Python bindings (part of the QScintilla2 package) 6. Install eric6 - If you want to use the interfaces to other supported software packages, you may - install them in any order and at any time. + If you want to use the interfaces to other supported software packages, + you may install them in any order and at any time. - Please note, that the QScintilla2 Python bindings have to be rebuild, if - the PyQt5 package gets updated. If this step is omitted, a bunch of strange - errors will occur. + Please note, that the QScintilla2 Python bindings have to be rebuild, + if the PyQt5 package gets updated. If this step is omitted, a bunch of + strange errors will occur. Installation of translations - Translations of the eric6 IDE are available as separate downloads. There - are two ways to install them. + Translations of the eric6 IDE are available as separate downloads. + There are two ways to install them. The first possibility is to install them together with eric6. In order to do that, simply extract the downloaded archives into the same place @@ -54,11 +56,12 @@ Running Just call up eric6, which will start the IDE. Use the "what is"-help - (arrow with ?) to get some help. Sorry, there is no documentation yet. - To start the unit test module in a standalone variant simply call up - eric6-unittest. This will show the same dialog (though with a little bit less - functionality) as if started from within eric6. The helpviewer can be - started as a standalone program by executing the eric6-webbrowser script. + (arrow with ?) to get some help. The eric web site provides some + documents describing certain aspects of eric. To start the unit test + module in a standalone variant simply call up eric6-unittest. This + will show the same dialog (though with a little bit less functionality) + as if started from within eric6. The web browser can be started as a + standalone program by executing the eric6-webbrowser script. Please note, the first time you start eric6 it will recognize, that it hasn't been configured yet and will show the configuration dialog. @@ -67,43 +70,43 @@ Running from the sources - If you want to run eric6 from within the source tree you have to execute - the compileUiFiles.py script once after a fresh checkout from the source - repository or when new dialogs have been added. Thereafter just execute - the eric6.py script. + If you want to run eric6 from within the source tree you have to + execute the compileUiFiles.py script once after a fresh checkout from + the source repository or when new dialogs have been added. Thereafter + just execute the eric6.py script. Tray starter - eric6 comes with a little utility called "eric6-tray". This embeds an icon - in the system tray, which contains a context menu to start eric6 and all - it's utilities. Double clicking this icon starts the eric6 IDE. + eric6 comes with a little utility called "eric6-tray". This embeds an + icon in the system tray, which contains a context menu to start eric6 + and all it's utilities. Double clicking this icon starts the eric6 IDE. Autocompletion/Calltips - eric6 provides an interface to the QScintilla auto-completion and calltips - functionality. QScintilla2 comes with API files for Python and itself. PyQt4 - contains an API file as well. These are installed by default, if the correct - installation order (see above) is followed. An API file for eric6 is - installed in the same place. + eric6 provides an interface to the QScintilla auto-completion and + calltips functionality. QScintilla2 comes with API files for Python + and itself. PyQt4 and PyQt5 contain API files as well. These are + installed by default, if the correct installation order (see above) is + followed. An API file for eric6 is installed in the same place. - In order to use autocompletion and calltips in eric6 please configure these - functions in the "Preferences Dialog" on the "Editor -> APIs", + In order to use autocompletion and calltips in eric6 please configure + these functions in the "Preferences Dialog" on the "Editor -> APIs", "Editor -> Autocompletion" and "Editor -> Calltips" pages. Remote Debugger - In order to enable the remote debugger start eric6, open the preferences - dialog and configure the settings on the debugger pages. + In order to enable the remote debugger start eric6, open the + preferences dialog and configure the settings on the debugger pages. The remote login must be possible without any further interaction (i.e. no password prompt). If the remote setup differs from the local one you must configure the Python interpreter and the Debug Client to be used in the Preferences dialog. eric6 includes two different versions of the debug client. DebugClient.py is the traditional debugger and - DebugClientThreads is a multithreading variant of the debug client. - Please copy all needed files to a place accessible through the Python path - of the remote machine and set the entries of the a.m. configuration tab - accordingly. + DebugClientThreads.py is a multithreading variant of the debug client. + Please copy all needed files to a place accessible through the Python + path of the remote machine and set the entries of the a.m. + configuration tab accordingly. Passive Debugging @@ -111,12 +114,12 @@ of the IDE. The IDE waits for a connection attempt. For further details see the file README-passive-debugging.txt - Plugin System + Plug-in System - eric6 contains a plugin system, that is used to extend eric6's - functionality. Some plugins are part of eric6. Additional plugins - are available via the Internet. Please use the built in plug-in - repository dialog to get a list of available (official) plugins + eric6 contains a plug-in system, that is used to extend eric6's + functionality. Some plug-ins are part of eric6. Additional plug-ins + are available via the Internet. Please use the built-in plug-in + repository dialog to get a list of available (official) plug-ins and to download them. For more details about the plug-in system please see the documentation area. @@ -126,56 +129,61 @@ packages. Qt-Designer - This is part of the Qt distribution and is used to generate user - interfaces. + This is part of the Qt distribution and is used to generate + user interfaces. Qt-Linguist - This is part of the Qt distribution and is used to generate translations. + This is part of the Qt distribution and is used to generate + translations. Qt-Assistant - This is part of the Qt distribution and may be used to display help files. + This is part of the Qt distribution and may be used to display + help files. Mercurial This is a distributed version control system available from <mercurial.selenic.com>. It is the one used by eric6 itself. Subversion - This is a version control system available from <subversion.apache.org>. - eric6 supports two different Subversion interfaces. One is using - the svn command line tool, the other is using the PySvn Python - interface <pysvn.tigris.org>. The selection is done automatically - depending on the installed software. The PySvn interface is prefered. - This automatism can be overridden an a per project basis using - the "User Properties" dialog. + This is a version control system available from + <http://subversion.apache.org>. eric6 supports two different + Subversion interfaces. One is using the svn command line tool, + the other is using the PySvn Python interface + <http://pysvn.tigris.org>. The selection is done automatically + depending on the installed software. The PySvn interface is + prefered. This automatism can be overridden an a per project + basis using the "User Properties" dialog. coverage.py - This is a tool to check Python code coverage. A slightly modified - version is part of the eric6 distribution. The original version is - available from <www.nedbatchelder.com/code/modules/coverage.html> + This is a tool to check Python code coverage. A slightly + modified version is part of the eric6 distribution. The + original version is available from + <http://www.nedbatchelder.com/code/modules/coverage.html> tabnanny - This is a tool to check Python code for white-space related problems. It - is part of the standard Python installation. + This is a tool to check Python code for white-space related + problems. It is part of the standard Python installation. profile - This is part of the standard Python distribution and is used to profile - Python source code. + This is part of the standard Python distribution and is used + to profile Python source code. Internationalization - eric6 and it's tools are prepared to show the UI in different - languages, which 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. 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. + eric6 and its tools are prepared to show the UI in different languages, + which 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. 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. 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 different window layouts. In these layouts, the shell + window and the file browser may be embedded or be separat windows. Source code documentation @@ -185,15 +193,16 @@ License - eric6 (and the others) is released under the conditions of the GPL. See - separate license file for more details. Third party software included in - eric6 is released under their respective license and contained in the - eric6 distribution for convenience. + eric6 (and the others) is released under the conditions of the GPL. + See separate license file for more details. Third party software + included in eric6 is released under their respective license and + contained in the eric6 distribution for convenience. Bugs and other reports - Please send bug reports, feature requests or contributions to eric bugs address. - After the IDE is installed you can use the "Report Bug..." entry of the Help menu, - which will send an email to <eric-bugs@eric-ide.python-projects.org. To request - a new feature use the "Request Feature..." entry of the Help menu, which will - send an email to <eric-featurerequest@eric-ide.python-projects.org. + Please send bug reports, feature requests or contributions to eric + bugs address. After the IDE is installed you can use the + "Report Bug..." entry of the Help menu, which will send an email to + <eric-bugs@eric-ide.python-projects.org. To request a new feature use + the "Request Feature..." entry of the Help menu, which will send an + email to <eric-featurerequest@eric-ide.python-projects.org.
--- a/README-MacOSX.txt Sun May 17 16:55:30 2015 +0200 +++ b/README-MacOSX.txt Mon May 25 16:27:07 2015 +0200 @@ -39,7 +39,7 @@ -------------- Download the Qt5 package from -http://qt-project.org/downloads +http://www.qt.io/download/ After the download finished open the downloaded package and install it. The tools (e.g. Designer, Linguist) can be found in the location @@ -65,10 +65,9 @@ After the download has finished open a Finder window and extract the downloaded archive in the Downloads folder (or any other folder of your choice). Change to -the Qt4 directory within the extracted folder and enter these commands in a +the Qt4Qt5 directory within the extracted folder and enter these commands in a terminal window -Qt5: qmake qscintilla.pro make -j x (number of cores including hyper threaded ones) sudo make install @@ -133,7 +132,7 @@ 9. Install aspell and dictionaries ----------------------------------- -eric4 includes the capability to perform spell checking of certain parts of +eric6 includes the capability to perform spell checking of certain parts of the sources. This is done via enchant which works with various spell checking libraries as it's backend. It depends upon aspell and hunspell. In order to install aspell enter this command in a terminal window @@ -153,7 +152,7 @@ 10. Install hunspell and dictionaries ------------------------------------- -penchant depends on hunspell as well. Enter these commands to install it +pyenchant depends on hunspell as well. Enter these commands to install it sudo port install hunspell @@ -165,6 +164,10 @@ Then install them with a command like this +sudo port install hunspell-dict-de_DE + +replacing the 'de_DE' part with the language code of your desire. + 11. Install enchant ------------------- @@ -175,20 +178,10 @@ 12. Install pyenchant --------------------- -Get the penchant sources from - -http://pypi.python.org/pypi/pyenchant/1.6.6 - -Extract the downloaded sources, change to the sources directory and enter -this command +Install pyenchant using the 'pip' utility. To do this just enter this +in a console window -sudo python3 setup.py install - -If you get a TypeError during the above operations open the file listed -last (easy_install.py, line 1447) add a comment sign in front of it and -enter this line right after it - -first_line_re = re.compile('^#!.*python[0-9.]*([ \t].*)?$') +sudo pip3 install pyenchant In order to test, if everything worked ok open a Python shell and enter these commands @@ -267,7 +260,8 @@ It is recommended to configure at least the path to the Qt tools on the Qt page and the paths to the various help pages on the Help Documentation page. The -values to be entered are given above in the Python and Qt installation sections. +values to be entered are given above in the Python and Qt installation +sections. 17. Install optional packages for eric6 (for plug-ins) @@ -279,50 +273,19 @@ 17.1 Installation of pylint --------------------------- -pylint is a tool to check Python sources for issues. In order to get it -installed you have to download these packages with the latest version each. - -http://download.logilab.org/pub/pylint -http://download.logilab.org/pub/astng -http://download.logilab.org/pub/common - -Once the downloads have been finished, extract all three packages and install -them with these commands. - -In the logilab-common-<version> directory do +pylint is a tool to check Python sources for issues. Install pylint using +the 'pip' utility. To do this just enter this in a console window -sudo python3 setup.py install - -In the logilab-astng-<version> directory do - -sudo python3 setup.py install - -In the pylint-<version> directory do - -sudo python3 setup.py install - -Note: You may receive some errors during the above steps. They just relate to -the tests included in the packages. If this occurs, please delete the faulty -test file and retry. As of pylint 0.25.0 this file was -"test/input/func_unknown_encoding.py". +sudo pip3 install pylint 17.2 Installation of cx_freeze ------------------------------ -cx_freeze is a tool that packages a Python application into executables. It is -like py2exe and py2app. Get the sources from - -http://cx-freeze.sourceforge.net/ +cx_Freeze is a tool that packages a Python application into executables. It is +like py2exe and py2app. Install cx_Freeze using the 'pip' utility. To do +this just enter this in a console window -and extract the downloaded source archive. cx_freeze needs to compile some -C sources and expects the compiler to be called gcc-4.2. This is not in the -executable path. In order to get this changed, cd to /usr/bin and do - -sudo ln -s gcc gcc-4.2 - -In the extracted cx_freeze directory execute the command - -sudo python3 setup.py install +sudo pip3 install cx_Freeze This completes this installation instruction. Please enjoy using eric6 and let the world know about it.
