Made some corrections to the various README files and converted them to reStructured Text.

Mon, 25 May 2015 16:28:18 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 25 May 2015 16:28:18 +0200
changeset 4266
17c215c416ba
parent 4263
7c7cb5188773
child 4267
94496d77156b

Made some corrections to the various README files and converted them to reStructured Text.

README file | annotate | diff | comparison | revisions
README-MacOSX.rst file | annotate | diff | comparison | revisions
README-MacOSX.txt file | annotate | diff | comparison | revisions
README-eric6-doc.rst file | annotate | diff | comparison | revisions
README-eric6-doc.txt file | annotate | diff | comparison | revisions
README-i18n.rst file | annotate | diff | comparison | revisions
README-i18n.txt file | annotate | diff | comparison | revisions
README-passive-debugging.rst file | annotate | diff | comparison | revisions
README-passive-debugging.txt file | annotate | diff | comparison | revisions
README.rst file | annotate | diff | comparison | revisions
eric6.e4p file | annotate | diff | comparison | revisions
--- a/README	Sun May 17 16:55:30 2015 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,199 +0,0 @@
-README for the eric6 IDE
-    
-    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.
-        
-        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 the required packages (Qt5, QScintilla2, sip and PyQt5) are not installed, 
-        please get them and install them in the following order (order is important).
-        
-            1. Install Qt5 (from Nokia)
-            
-            2. Build and install QScintilla2 (from Riverbank Computing)
-            
-            3. Build and install sip (from Riverbank Computing)
-            
-            4. Build and install PyQt5 (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.
-        
-        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.
-        
-        The first possibility is to install them together with eric6. In order
-        to do that, simply extract the downloaded archives into the same place
-        as the eric6 archive and follow the installation instructions above.
-        
-        The second possibility is to install them separately. Extract the
-        downloaded archives and execute the install-i18n.py script (type
-        python install-i18n.py -h for some help). This way you can make the
-        translations available to everybody or just to the user executing the
-        installation command (if using the -p switch).
-    
-    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.
-        
-        Please note, the first time you start eric6 it will recognize, that it
-        hasn't been configured yet and will show the configuration dialog.
-        Please take your time and go through all the configuration items.
-        However, every configuration option has a meaningful default value.
-    
-    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.
-    
-    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.
-    
-    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.
-        
-        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.
-        
-        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. 
-    
-    Passive Debugging
-    
-        Passive debugging mode allows the startup of the debugger from outside
-        of the IDE. The IDE waits for a connection attempt. For further details
-        see the file README-passive-debugging.txt
-    
-    Plugin 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
-        and to download them. For more details about the plug-in system
-        please see the documentation area.
-    
-    Interfaces to additional software packages
-    
-        At the moment eric6 provides interfaces to the following software
-        packages.
-        
-            Qt-Designer 
-                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.
-            
-            Qt-Assistant 
-                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.
-            
-            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>
-            
-            tabnanny 
-                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.
-    
-    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.
-    
-    Window Layout
-    
-        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
-    
-        eric6 has a built in source code documentation generator, which is
-        usable via the commandline as well. For further details please see
-        the file README-eric6-doc.txt
-    
-    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. 
-    
-    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.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README-MacOSX.rst	Mon May 25 16:28:18 2015 +0200
@@ -0,0 +1,335 @@
+====================
+Readme for Mac usage
+====================
+
+This Readme file describes how to prepare a Mac computer for eric. The
+recommended way to do this is to install the software packages from the
+distributors web pages. Because some software is only available as source
+and compilation is a bit tricky because of the dependencies, these packages
+should be installed via a packaging system. The recommended one is MacPorts
+because of it's completeness. This is the way described below.
+
+
+1. Install Xcode
+----------------
+Open the Mac App Store and enter "xcode" into the search entry at the top
+right of the window. From the list of results select the Xcode entry. Xcode
+is provided free of charge. On the Xcode page select the button to get the
+package. Follow the usual procedure to start the download. Once the download
+has finished open the applications folder and select the "Install Xcode" entry.
+In contrast to the Xcode 3 procedure described above, the installer does not
+ask for a selection of sub-packages.
+
+
+2. Install Python 3.4
+---------------------
+Although Mac OS X comes with a python installation it is recommended to
+install the python package provided by the Python community. Download it
+from 
+
+http://www.python.org/download/
+
+After the download finished open the downloaded package and install it.
+
+Note: The Python documentation can be found in these locations
+
+/Library/Frameworks/Python.framework/Versions/3.4/Resources/English.lproj/Documentation/index.html
+/Applications/Python 3.4/Python Documentation.html
+
+3. Install Qt5
+--------------
+Download the Qt5 package from
+
+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
+
+| ˜/Qt<version>/<version>/<compiler>/bin
+| e.g. ˜/Qt5.3.0/5.3.0/clang_64/bin
+
+The documentation can be found in these locations
+
+˜/Qt<version>/<version>/<compiler>/qtdoc (HTML format)
+˜/Qt<version>/<version>/<compiler>/ (QtHelp format)
+
+The translation files can be found in this location
+
+˜/Qt<version>/<version>/<compiler>//translations
+
+
+4. Install QScintilla2
+----------------------
+Download the QScintilla2 source code package from
+
+http://www.riverbankcomputing.com/software/qscintilla/download
+
+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 Qt4Qt5 directory within the extracted folder and enter these commands in a
+terminal window
+
+::
+
+    qmake qscintilla.pro
+    make -j x (number of cores including hyper threaded ones)
+    sudo make install
+
+
+5. Install sip
+--------------
+Download the sip source code package from
+
+http://www.riverbankcomputing.com/software/sip/download
+
+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 extracted folder and enter these commands in a terminal window
+
+::
+
+    python3 configure.py
+    make -j x (number of cores including hyper threaded ones)
+    sudo make install
+
+
+6. Install PyQt5
+----------------
+Download the PyQt5 source code package from
+
+http://www.riverbankcomputing.com/software/pyqt/download5
+
+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 extracted folder and enter these commands in a terminal window
+
+::
+
+    python3 configure.py -c -j x (number of cores including hyper threaded ones)
+    make -j x (number of cores including hyper threaded ones)
+    sudo make install
+
+
+7. Install QScintilla2 Python bindings
+--------------------------------------
+Change back to the extracted QScintilla2 directory and in there change to the
+Python subdirectory. Enter these commands in a terminal window
+
+::
+
+    python3 configure.py --pyqt=PyQt5 -c -j x (number of cores including hyper threaded ones)
+    make -j x (number of cores including hyper threaded ones)
+    sudo make install
+
+
+8. Install MacPorts
+-------------------
+MacPorts is a packaging system for the Mac. I recommend to install it to use
+some applications and libraries, that are a bit tricky to compile from source
+or for which the supplier doesn't offer ready built Mac OS X packages. In order
+to install MacPorts get the proper disk image (for Lion or Snow Leopard) from
+
+http://www.macports.org/install.php
+
+and install it with the usual procedure. You may read about it's usage via
+
+http://guide.macports.org/#using.port
+
+For a recipe on how to update MacPorts and the installed ports see the end
+of this file (Appendix A)
+
+
+9. Install aspell and dictionaries
+-----------------------------------
+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
+
+::
+
+    sudo port install aspell
+
+This installs aspell and a bunch of dependancies. Once aspell has been installed
+install the dictionaries of your desire. To get a list of available dictionaries
+enter
+
+::
+
+    port search aspell-dict
+
+Then install them with a command like this
+
+::
+
+    sudo port install aspell-dict-de aspell-dict-en
+
+
+10. Install hunspell and dictionaries
+-------------------------------------
+pyenchant depends on hunspell as well. Enter these commands to install it
+
+::
+
+    sudo port install hunspell
+
+This installs hunspell and a bunch of dependancies. Once hunspell has been
+installed, install the dictionaries of your desire. To get a list of hunspell
+dictionaries enter
+
+::
+
+    port search hunspell-dict
+
+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
+-------------------
+In order to install enchant and penchant via MacPorts enter these commands
+
+::
+
+    sudo port install enchant
+
+
+12. Install pyenchant
+---------------------
+Install ``pyenchant`` using the ``pip`` utility. To do this just enter this
+in a console window
+
+::
+
+    sudo pip3 install pyenchant
+
+In order to test, if everything worked ok open a Python shell and enter
+these commands
+
+>>> import enchant
+>>> enchant.list_dicts()
+
+If you get an error (ImportError for the first command or no dictionaries
+are show for the second command) please recheck the installation checks.
+
+
+13. Install pysvn
+-----------------
+Mac OS X already provides subversion. However, best performance for eric6 is
+gained with the pysvn interface to subversion. Therefore it is recommended to
+install pysvn. Get pysvn via 
+
+http://pysvn.tigris.org/project_downloads.html
+
+After the download finished open the downloaded package and install it.
+
+In order to test, if everything worked ok, open a Python shell and enter these
+commands
+
+>>> import pysvn
+>>> pysvn.version
+
+This should print the pysvn version as a tuple like ``(1, 7, 10, 1584)``. If
+you get an error please check your installation.
+
+Note: Mac OS X Lion provides Subversion 1.6.x. When downloading pysvn make sure
+      to download the variant compiled against that version. This is important
+      because the working copy format of Subversion 1.7.x is incompatible to
+      the old one.
+
+
+14. Install Mercurial
+---------------------
+Get Mercurial from
+
+http://mercurial.selenic.com/
+
+Extract the downloaded package and install it.
+
+
+15. Install eric6
+-----------------
+Get the latest eric6 distribution package from 
+
+http://eric-ide.python-projects.org/eric-download.html
+
+Just follow the link on this page to the latest download.
+
+Extract the downloaded package and language packs into a directory and install
+it with this command
+
+::
+
+    sudo python3 install.py
+
+This step concludes the installation procedure. You are ready for the first
+start of eric6.
+
+The eric6 installer created an application bundle in the location
+
+::
+
+    /Applications/eric6
+
+You may drag it to the dock to have it ready.
+
+
+16. First start of eric6
+------------------------
+When eric6 is started for the first time it will recognize that it hasn't been
+configured yet. Therefore it will start the configuration dialog with the
+default configuration. At this point you could simply close the dialog by
+pressing the OK button. However, it is strongly recommended that you go through
+the configuration pages to get a feeling for the configuration possibilities.
+
+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.
+
+
+17. Install optional packages for eric6 (for plug-ins)
+------------------------------------------------------
+eric6 provides an extension mechanism via plug-ins. Some of them require the
+installation of additional python packages. The plug-ins themselves are
+available via the Plugin Repository from within eric6.
+
+
+17.1 Installation of pylint
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+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 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. Install ``cx_Freeze`` using the ``pip`` utility. To do
+this just enter this in a console window
+
+::
+
+    sudo pip3 install cx_Freeze
+
+This completes this installation instruction. Please enjoy using eric6 and let
+the world know about it.
+
+
+Appendix A: Update of MacPorts
+------------------------------
+In order to update MacPorts and the installed packages enter these commands in
+a terminal window
+
+::
+
+    sudo port selfupdate        (update MacPorts itself)
+    sudo port upgrade outdated  (update outdated installed ports)
--- a/README-MacOSX.txt	Sun May 17 16:55:30 2015 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,337 +0,0 @@
-Readme for Mac usage
-====================
-
-This Readme file describes how to prepare a Mac computer for eric. The
-recommended way to do this is to install the software packages from the
-distributors web pages. Because some software is only available as source
-and compilation is a bit tricky because of the dependencies, these packages
-should be installed via a packaging system. The recommended one is MacPorts
-because of it's completeness. This is the way described below.
-
-
-1. Install Xcode
-----------------
-Open the Mac App Store and enter "xcode" into the search entry at the top
-right of the window. From the list of results select the Xcode entry. Xcode
-is provided free of charge. On the Xcode page select the button to get the
-package. Follow the usual procedure to start the download. Once the download
-has finished open the applications folder and select the "Install Xcode" entry.
-In contrast to the Xcode 3 procedure described above, the installer does not
-ask for a selection of sub-packages.
-
-
-2. Install Python 3.4
----------------------
-Although Mac OS X comes with a python installation it is recommended to
-install the python package provided by the Python community. Download it
-from 
-
-http://www.python.org/download/
-
-After the download finished open the downloaded package and install it.
-
-Note: The Python documentation can be found in these locations
-
-/Library/Frameworks/Python.framework/Versions/3.4/Resources/English.lproj/Documentation/index.html
-/Applications/Python 3.4/Python Documentation.html
-
-3. Install Qt5
---------------
-Download the Qt5 package from
-
-http://qt-project.org/downloads
-
-After the download finished open the downloaded package and install it. The
-tools (e.g. Designer, Linguist) can be found in the location
-
-˜/Qt<version>/<version>/<compiler>/bin
-e.g. ˜/Qt5.3.0/5.3.0/clang_64/bin
-
-The documentation can be found in these locations
-
-˜/Qt<version>/<version>/<compiler>/qtdoc (HTML format)
-˜/Qt<version>/<version>/<compiler>/ (QtHelp format)
-
-The translation files can be found in this location
-
-˜/Qt<version>/<version>/<compiler>//translations
-
-
-4. Install QScintilla2
-----------------------
-Download the QScintilla2 source code package from
-
-http://www.riverbankcomputing.com/software/qscintilla/download
-
-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
-terminal window
-
-Qt5:
-qmake qscintilla.pro
-make -j x (number of cores including hyper threaded ones)
-sudo make install
-
-
-5. Install sip
---------------
-Download the sip source code package from
-
-http://www.riverbankcomputing.com/software/sip/download
-
-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 extracted folder and enter these commands in a terminal window
-
-python3 configure.py
-make -j x (number of cores including hyper threaded ones)
-sudo make install
-
-
-6. Install PyQt5
-----------------
-Download the PyQt5 source code package from
-
-http://www.riverbankcomputing.com/software/pyqt/download5
-
-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 extracted folder and enter these commands in a terminal window
-
-python3 configure.py -c -j x (number of cores including hyper threaded ones)
-make -j x (number of cores including hyper threaded ones)
-sudo make install
-
-
-7. Install QScintilla2 Python bindings
---------------------------------------
-Change back to the extracted QScintilla2 directory and in there change to the
-Python subdirectory. Enter these commands in a terminal window
-
-python3 configure.py --pyqt=PyQt5 -c -j x (number of cores including hyper threaded ones)
-make -j x (number of cores including hyper threaded ones)
-sudo make install
-
-
-8. Install MacPorts
--------------------
-MacPorts is a packaging system for the Mac. I recommend to install it to use
-some applications and libraries, that are a bit tricky to compile from source
-or for which the supplier doesn't offer ready built Mac OS X packages. In order
-to install MacPorts get the proper disk image (for Lion or Snow Leopard) from
-
-http://www.macports.org/install.php
-
-and install it with the usual procedure. You may read about it's usage via
-
-http://guide.macports.org/#using.port
-
-For a recipe on how to update MacPorts and the installed ports see the end
-of this file (Appendix A)
-
-
-9. Install aspell and dictionaries
------------------------------------
-eric4 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
-
-sudo port install aspell
-
-This installs aspell and a bunch of dependancies. Once aspell has been installed
-install the dictionaries of your desire. To get a list of available dictionaries
-enter
-
-port search aspell-dict
-
-Then install them with a command like this
-
-sudo port install aspell-dict-de aspell-dict-en
-
-
-10. Install hunspell and dictionaries
--------------------------------------
-penchant depends on hunspell as well. Enter these commands to install it
-
-sudo port install hunspell
-
-This installs hunspell and a bunch of dependancies. Once hunspell has been
-installed, install the dictionaries of your desire. To get a list of hunspell
-dictionaries enter
-
-port search hunspell-dict
-
-Then install them with a command like this
-
-
-11. Install enchant
--------------------
-In order to install enchant and penchant via MacPorts enter these commands
-
-sudo port install enchant
-
-
-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
-
-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].*)?$')
-
-In order to test, if everything worked ok open a Python shell and enter
-these commands
-
->>> import enchant
->>> enchant.list_dicts()
-
-If you get an error (ImportError for the first command or no dictionaries
-are show for the second command) please recheck the installation checks.
-
-
-13. Install pysvn
------------------
-Mac OS X already provides subversion. However, best performance for eric6 is
-gained with the pysvn interface to subversion. Therefore it is recommended to
-install pysvn. Get pysvn via 
-
-http://pysvn.tigris.org/project_downloads.html
-
-After the download finished open the downloaded package and install it.
-
-In order to test, if everything worked ok, open a Python shell and enter these
-commands
-
->>> import pysvn
->>> pysvn.version
-
-This should print the pysvn version as a tuple like '(1, 7, 6, 0)'. If you get
-an error please check your installation.
-
-Note: Mac OS X Lion provides Subversion 1.6.x. When downloading pysvn make sure
-      to download the variant compiled against that version. This is important
-      because the working copy format of Subversion 1.7.x is incompatible to the
-      old one.
-
-
-14. Install Mercurial
----------------------
-Get Mercurial from
-
-http://mercurial.selenic.com/
-
-Extract the downloaded package and install it.
-
-
-15. Install eric6
------------------
-Get the latest eric6 distribution package from 
-
-http://eric-ide.python-projects.org/eric-download.html
-
-Just follow the link on this page to the latest download.
-
-Extract the downloaded package and language packs into a directory and install
-it with this command
-
-sudo python3 install.py
-
-This step concludes the installation procedure. You are ready for the first
-start of eric6.
-
-The eric6 installer created an application bundle in the location
-
-/Applications/eric6
-
-You may drag it to the dock to have it ready.
-
-
-16. First start of eric6
-------------------------
-When eric6 is started for the first time it will recognize that it hasn't been
-configured yet. Therefore it will start the configuration dialog with the
-default configuration. At this point you could simply close the dialog by
-pressing the OK button. However, it is strongly recommended that you go through
-the configuration pages to get a feeling for the configuration possibilities.
-
-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.
-
-
-17. Install optional packages for eric6 (for plug-ins)
-------------------------------------------------------
-eric6 provides an extension mechanism via plug-ins. Some of them require the
-installation of additional python packages. The plug-ins themselves are
-available via the Plugin Repository from within eric6.
-
-
-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
-
-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".
-
-
-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/
-
-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
-
-This completes this installation instruction. Please enjoy using eric6 and let
-the world know about it.
-
-
-Appendix A Update of MacPorts
------------------------------
-In order to update MacPorts and the installed packages enter these commands in a
-terminal window
-
-sudo port selfupdate        (update MacPorts itself)
-sudo port upgrade outdated  (update outdated installed ports)
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README-eric6-doc.rst	Mon May 25 16:28:18 2015 +0200
@@ -0,0 +1,211 @@
+================================================
+README for the eric6-doc documentation generator
+================================================
+
+eric6-doc is the documentation generator of the eric6 IDE. Python source
+code documentation may be included as ordinary Python doc-strings or as 
+documentation comments. For Quixote Template files (PTL) only documentation 
+comments are available due to the inner workings of Quixote. Documentation 
+comments start with the string ###, followed by the contents and ended by 
+###. Every line of the documentation comments contents must start with a # 
+(see example below).
+
+For Ruby files, the documentation string must be started with "=begin edoc"
+and must be ended with "=end". The documentation string for classes, modules
+and functions/methods must follow their defininition.
+
+Documentation for packages (i.e. directories) must be in a file called 
+__init__.py or __init__.rb. If a package directory doesn't contain a file
+like these, documentation for files in this directory is suppressed.
+
+The documentation consist of two parts. The first part is the description of 
+the module, class, function or method. The second part, separated from the 
+first by a blank line, consists of one or more tags. These are described below.
+
+eric6-doc produces HTML files from the documentation found within the source 
+files scaned. It understands the following commandline parameters next to
+others.
+
+-o directory
+  Generate files in the named directory.
+
+-R, -r
+  Perform a recursive search for Python files.
+
+-x directory
+  Specify a directory basename to be excluded. This option may be repeated
+  multiple times.
+
+-i
+  Don't generate index files.
+
+Just type "eric6-doc" to get some usage information.
+
+1. Description
+--------------
+The descriptions are HTML fragments and may contain most standard HTML. The
+description text is included in the output wrapped in P tags, but unchanged 
+otherwise. Paragraphs have to be separated by a blank line. In order to
+generate a blank line in the output enter a line that contains a single dot
+(.). Reserved HTML entities (<, > and &) and the at-sign (@) at the beginning 
+of a line, if that line doesn't contain a tag (see below), must be properly 
+escaped. "<" should be written as "&lt;", ">" as "&gt;", "&" as "&amp;" and
+"@" should be escaped as "@@".
+
+The documentation string or documentation comment may contain block tags
+and inline tags. Inline tags are denoted by curly braces and can be placed
+anywhere in the main description or in the description part of block tags.
+Block tags can only be placed in the tag section that follows the main
+description. Block tags are indicated by an at-sign (@) at the beginning of
+the line. The text before the first tag is the description of a module, class,
+method or function.
+
+Python Docstring::
+
+    """
+    This is sentence one, which gets included as a short description.
+    All additional sentences are included into the full description.
+    
+    @param param1 first parameter
+    @exception ValueError list entry wasn't found
+    @return flag indicating success
+    """
+    
+Python/Quixote Documentation comment::
+
+    ###
+    # This is line one, which gets included as a short description.
+    # All additional lines are included into the full description.
+    #
+    # @param param1 first parameter
+    # @exception ValueError list entry wasn't found
+    # @return flag indicating success
+    ###
+    
+Ruby Docstring::
+
+    =begin edoc
+    This is line one, which gets included as a short description.
+    All additional lines are included into the full description.
+    
+    @param param1 first parameter
+    @exception ValueError list entry wasn't found
+    @return flag indicating success
+    =end
+
+2. Block Tags
+-------------
+The block tags recogized by eric6-doc are:
+
+@@
+
+    This isn't really a tag. This is used to escape an at sign at the beginning
+    of a line. Everything after the first @ is copied verbatim to the output.
+
+@author author
+
+    This tag is used to name the author of the code. For example:
+    @author Detlev Offenbach <detlev@die-offenbachs.de>
+
+@deprecated description
+
+    This tag is used to mark a function or method as deprecated. It is always 
+    followed by one or more lines of descriptive text.
+
+@event eventname description
+
+    This tag is used to describe the events (PyQt) a class may emit. It is 
+    always followed by the event name and one or more lines of descriptive 
+    text. For example:
+    
+    @event closeEvent Emitted when an editor window is closed.
+
+@exception exception description
+
+    These tags are used to describe the exceptions a function or method may 
+    raise. It is always followed by the exception name and one or more lines 
+    of descriptive text. For example:
+    
+    @exception ValueError The searched value is not contained in the list.
+
+@keyparam name description
+
+    This tag is like the @param tag, but should be used for parameters, that 
+    should always be given as keyword parameters. It is always followed by 
+    the argument name and one or more lines of descriptive text. For example:
+    
+    @keyparam extension Optional extension of the source file.
+
+@param name description
+
+    This tag is used to describe a function or method argument. It is always 
+    followed by the argument name and one or more lines of descriptive text.
+    For example:
+    
+    @param filename Name of the source file.
+
+@raise exception description
+
+    This tag is an alias for the @exception tag.
+
+@return description
+
+    This tag is used to describe a functions or methods return value. It can 
+    include one or more lines of descriptive text. For example:
+    
+    @return list of description strings
+
+@see reference
+
+    This tag is used to include a reference in the documentation. It comes in
+    three different forms.
+
+    @see "string"
+    
+        Adds a text entry of string. No link is generated. eric6-doc distinguishes
+        this form from the others by looking for a double-quote (") as the first
+        character. For example:
+
+        @see "eric6-doc readme file"
+
+    @see <a href="URL#value">label</a>
+    
+        Adds a link as defined by URL#value. eric6-doc distinguishes this form from
+        the others by looking for a less-than symbol (<) as the first character.
+        For example:
+
+        @see <a href="eric6.eric6-doc.html>eric6-doc documentation generator</a>
+
+    @see package.module#member label
+    
+        Adds a link to "member" in "module" in "package". package can be a package
+        path, where the package names are separated by a dot character (.). The
+        "package.module#member" part must not be split over several lines and
+        must name a valid target within the documentation directory. For example:
+
+        @see eric6.eric6-doc#main eric6-doc main() function
+        @see eric6.DocumentationTools.ModuleDocumentor#ModuleDocument.__genModuleSection
+            ModuleDocument.__genModuleSection
+
+@signal signalname description
+
+    This tag is used to describe the signals (PyQt) a class may emit. It is 
+    always followed by the signal name and one or more lines of descriptive 
+    text. For example:
+    
+    @signal lastEditorClosed Emitted after the last editor window was 
+        closed.
+
+@throws exception description
+
+    This tag is an alias for the @exception tag.
+
+3. Inline Tags
+--------------
+The inline tags recogized by eric6-doc are:
+
+{@link package.module#member label}
+
+    Inserts an in-line link with visible text label that points to the documentation
+    given in the reference. This tag works he same way as the @see block tag of this
+    form.
--- a/README-eric6-doc.txt	Sun May 17 16:55:30 2015 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,189 +0,0 @@
-README for the eric6-doc documentation generator
-
-    eric6-doc is the documentation generator of the eric6 IDE. Python source
-    code documentation may be included as ordinary Python doc-strings or as 
-    documentation comments. For Quixote Template files (PTL) only documentation 
-    comments are available due to the inner workings of Quixote. Documentation 
-    comments start with the string ###, followed by the contents and ended by 
-    ###. Every line of the documentation comments contents must start with a # 
-    (see example below).
-    
-    For Ruby files, the documentation string must be started with "=begin edoc"
-    and must be ended with "=end". The documentation string for classes, modules
-    and functions/methods must follow their defininition.
-    
-    Documentation for packages (i.e. directories) must be in a file called 
-    __init__.py or __init__.rb. If a package directory doesn't contain a file
-    like these, documentation for files in this directory is suppressed.
-    
-    The documentation consist of two parts. The first part is the description of 
-    the module, class, function or method. The second part, separated from the 
-    first by a blank line, consists of one or more tags. These are described below.
-    
-    eric6-doc produces HTML files from the documentation found within the source 
-    files scaned. It understands the following commandline parameters next to others.
-    
-    -o directory
-      Generate files in the named directory.
-    
-    -R, -r
-      Perform a recursive search for Python files.
-    
-    -x directory
-      Specify a directory basename to be excluded. This option may be repeated
-      multiple times.
-    
-    -i
-      Don't generate index files.
-    
-    Just type "eric6-doc" to get some usage information.
-    
-    Description
-    -----------
-    The descriptions are HTML fragments and may contain most standard HTML. The
-    description text is included in the output wrapped in P tags, but unchanged 
-    otherwise. Paragraphs have to be separated by a blank line. In order to
-    generate a blank line in the output enter a line that contains a single dot
-    (.). Reserved HTML entities (<, > and &) and the at-sign (@) at the beginning 
-    of a line, if that line doesn't contain a tag (see below), must be properly 
-    escaped. "<" should be written as "&lt;", ">" as "&gt;", "&" as "&amp;" and
-    "@" should be escaped as "@@".
-    
-    The documentation string or documentation comment may contain block tags
-    and inline tags. Inline tags are denoted by curly braces and can be placed
-    anywhere in the main description or in the description part of block tags.
-    Block tags can only be placed in the tag section that follows the main
-    description. Block tags are indicated by an at-sign (@) at the beginning of
-    the line. The text before the first tag is the description of a module, class,
-    method or function.
-    
-    Python Docstring:
-        """
-        This is sentence one, which gets included as a short description.
-        All additional sentences are included into the full description.
-        
-        @param param1 first parameter
-        @exception ValueError list entry wasn't found
-        @return flag indicating success
-        """
-        
-    Python/Quixote Documentation comment:
-        ###
-        # This is line one, which gets included as a short description.
-        # All additional lines are included into the full description.
-        #
-        # @param param1 first parameter
-        # @exception ValueError list entry wasn't found
-        # @return flag indicating success
-        ###
-        
-    Ruby Docstring:
-        =begin edoc
-        This is line one, which gets included as a short description.
-        All additional lines are included into the full description.
-        
-        @param param1 first parameter
-        @exception ValueError list entry wasn't found
-        @return flag indicating success
-        =end
-
-    Block Tags
-    ----------
-    The block tags recogized by eric6-doc are:
-
-    @@
-        This isn't really a tag. This is used to escape an at sign at the beginning
-        of a line. Everything after the first @ is copied verbatim to the output.
-
-    @author author
-        This tag is used to name the author of the code. For example:
-        @author Detlev Offenbach <detlev@die-offenbachs.de>
-
-    @deprecated description
-        This tag is used to mark a function or method as deprecated. It is always 
-        followed by one or more lines of descriptive text.
-
-    @event eventname description
-        This tag is used to describe the events (PyQt) a class may emit. It is 
-        always followed by the event name and one or more lines of descriptive 
-        text. For example:
-        
-        @event closeEvent Emitted when an editor window is closed.
-    
-    @exception exception description
-        These tags are used to describe the exceptions a function or method may 
-        raise. It is always followed by the exception name and one or more lines 
-        of descriptive text. For example:
-        
-        @exception ValueError The searched value is not contained in the list.
-    
-    @keyparam name description
-        This tag is like the @param tag, but should be used for parameters, that 
-        should always be given as keyword parameters. It is always followed by 
-        the argument name and one or more lines of descriptive text. For example:
-        
-        @keyparam extension Optional extension of the source file.
-    
-    @param name description
-        This tag is used to describe a function or method argument. It is always 
-        followed by the argument name and one or more lines of descriptive text.
-        For example:
-        
-        @param filename Name of the source file.
-    
-    @raise exception description
-        This tag is an alias for the @exception tag.
-
-    @return description
-        This tag is used to describe a functions or methods return value. It can 
-        include one or more lines of descriptive text. For example:
-        
-        @return list of description strings
-    
-    @see reference
-        This tag is used to include a reference in the documentation. It comes in
-        three different forms.
-
-        @see "string"
-            Adds a text entry of string. No link is generated. eric6-doc distinguishes
-            this form from the others by looking for a double-quote (") as the first
-            character. For example:
-
-            @see "eric6-doc readme file"
-
-        @see <a href="URL#value">label</a>
-            Adds a link as defined by URL#value. eric6-doc distinguishes this form from
-            the others by looking for a less-than symbol (<) as the first character.
-            For example:
-
-            @see <a href="eric6.eric6-doc.html>eric6-doc documentation generator</a>
-
-        @see package.module#member label
-            Adds a link to "member" in "module" in "package". package can be a package
-            path, where the package names are separated by a dot character (.). The
-            "package.module#member" part must not be split over several lines and
-            must name a valid target within the documentation directory. For example:
-
-            @see eric6.eric6-doc#main eric6-doc main() function
-            @see eric6.DocumentationTools.ModuleDocumentor#ModuleDocument.__genModuleSection
-                ModuleDocument.__genModuleSection
-
-    @signal signalname description
-        This tag is used to describe the signals (PyQt) a class may emit. It is 
-        always followed by the signal name and one or more lines of descriptive 
-        text. For example:
-        
-        @signal lastEditorClosed Emitted after the last editor window was 
-            closed.
-    
-    @throws exception description
-        This tag is an alias for the @exception tag.
-
-    Inline Tags
-    -----------
-    The inline tags recogized by eric6-doc are:
-
-    {@link package.module#member label}
-        Inserts an in-line link with visible text label that points to the documentation
-        given in the reference. This tag works he same way as the @see block tag of this
-        form.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README-i18n.rst	Mon May 25 16:28:18 2015 +0200
@@ -0,0 +1,20 @@
+=======================================    
+README for the eric6 IDE's translations
+=======================================
+
+1. Installation of translations
+-------------------------------
+
+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
+as the eric6 archive and follow the installation instructions of the
+eric6 README.
+
+The second possibility is to install them separately. Extract the
+downloaded archives and execute the install-i18n.py script (type
+python install-i18n.py -h for some help). This way you can make the
+translations available to everybody or just to the user executing the
+installation command (if using the -p switch).
--- a/README-i18n.txt	Sun May 17 16:55:30 2015 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,17 +0,0 @@
-README for the eric6 IDE's translations
-    
-    Installation of translations
-    
-        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
-        as the eric6 archive and follow the installation instructions of the
-        eric6 README.
-        
-        The second possibility is to install them separately. Extract the
-        downloaded archives and execute the install-i18n.py script (type
-        python install-i18n.py -h for some help). This way you can make the
-        translations available to everybody or just to the user executing the
-        installation command (if using the -p switch).
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README-passive-debugging.rst	Mon May 25 16:28:18 2015 +0200
@@ -0,0 +1,58 @@
+README for passive mode debugging
+=================================
+
+eric6 provides the capability to debug programms using the passive
+mode. In this mode it is possible to start the debugger separate from
+the IDE. This may be done on a different computer as well. If the
+debugger is started on a remote machine, it is your responsibility
+to ensure, that the paths to the script to be debugged are identical
+on both machines.
+
+In order to enable passive mode debugging in the IDE choose the
+debugger tab of the preferences dialog and enable the passive mode
+debugging checkbox. You may change the default port as well. Please
+be aware that you have to tell the debugger the port, if it is different to the 
+default value of 42424.
+
+On the remote computer you have to have the debugger scripts installed.
+Use DebugClient.py to debug normal scripts or DebugClientThreads.py
+to debug multi threaded scripts. The debuggers know about the following
+commandline switches.
+
+::
+
+    -h <hostname>
+        This specifies the hostname of the machine running the IDE.
+    -p <portnumber>
+        This specifies the portnumber of the IDE.
+    -w <directory>
+        This specifies the working directory to be used for the script
+        to be debugged.
+    -t
+        This enables tracing into the Python library.
+    -n
+        This disables the redirection of stdin, stdout and stderr.
+    -e
+        This disables reporting of exceptions.
+    --fork-child
+        This tells the debugger to follow the child when forking.
+    --fork-parent
+        This tells the debugger to follow the parent when forking
+
+The commandline parameters have to be followed by ``'--'`` (double dash),
+the script to be debugged and its commandline parameters.
+
+Example::
+
+    python DebugClient -h somehost -- myscript.py param1
+    
+After the execution of the debugger command, it connects to the IDE and
+tells it the filename of the script being debugged. The IDE will try to load it
+and the script will stop at the first line. After that you may set breakpoints,
+step through your script and use all the debugging functions.
+
+Note: The port and hostname may alternatively be set through the environment
+variables ERICPORT and ERICHOST.
+
+Please send bug reports, feature requests or contributions to eric bugs address
+<eric-bugs@die-offenbachs.de> or using the buildt in bug reporting dialog.
--- a/README-passive-debugging.txt	Sun May 17 16:55:30 2015 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,53 +0,0 @@
-README for passive mode debugging
-
-    eric6 provides the capability to debug programms using the passive
-    mode. In this mode it is possible to start the debugger separate from
-    the IDE. This may be done on a different computer as well. If the
-    debugger is started on a remote machine, it is your responsibility
-    to ensure, that the paths to the script to be debugged are identical
-    on both machines.
-    
-    In order to enable passive mode debugging in the IDE choose the
-    debugger tab of the preferences dialog and enable the passive mode
-    debugging checkbox. You may change the default port as well. Please
-    be aware that you have to tell the debugger the port, if it is different to the 
-    default value of 42424.
-    
-    On the remote computer you have to have the debugger scripts installed.
-    Use DebugClient.py to debug normal scripts or DebugClientThreads.py
-    to debug multi threaded scripts. The debuggers know about the following
-    commandline switches.
-    
-    -h <hostname> -- this specifies the hostname of the machine running the IDE.
-    
-    -p <portnumber> -- this specifies the portnumber of the IDE.
-    
-    -w <directory> -- this specifies the working directory to be used for the script
-        to be debugged.
-    
-    -t -- this enables tracing into the Python library
-    
-    -n -- this disables the redirection of stdin, stdout and stderr
-    
-    -e -- this disables reporting of exceptions
-    
-    --fork-child -- this tells the debugger to follow the child when forking
-    
-    --fork-parent -- this tells the debugger to follow the parent when forking
-    
-    The commandline parameters have to be followed by '--' (double dash),
-    the script to be debugged and its commandline parameters.
-    
-    Example::
-        python DebugClient -h somehost -- myscript.py param1
-        
-    After the execution of the debugger command, it connects to the IDE and
-    tells it the filename of the script being debugged. The IDE will try to load it
-    and the script will stop at the first line. After that you may set breakpoints,
-    step through your script and use all the debugging functions.
-    
-    Note: The port and hostname may alternatively be set through the environment
-    variables ERICPORT and ERICHOST.
-    
-    Please send bug reports, feature requests or contributions to eric bugs address
-    <eric-bugs@die-offenbachs.de> or using the buildt in bug reporting dialog.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Mon May 25 16:28:18 2015 +0200
@@ -0,0 +1,207 @@
+========================
+README for the eric6 IDE
+========================
+
+1. 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 called eric6 in the standard
+executable directory.
+
+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.
+
+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 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)
+
+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.
+
+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.
+
+2. Installation of translations
+-------------------------------
+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
+as the eric6 archive and follow the installation instructions above.
+
+The second possibility is to install them separately. Extract the
+downloaded archives and execute the install-i18n.py script (type
+``python install-i18n.py -h`` for some help). This way you can make the
+translations available to everybody or just to the user executing the
+installation command (if using the -p switch).
+
+3. Running
+----------
+Just call up eric6, which will start the IDE. Use the "what is"-help
+(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.
+Please take your time and go through all the configuration items.
+However, every configuration option has a meaningful default value.
+
+4. 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.
+
+5. 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.
+
+6. Autocompletion/Calltips
+--------------------------
+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", 
+"Editor -> Autocompletion" and "Editor -> Calltips" pages.
+
+7. Remote Debugger
+------------------
+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.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. 
+
+8. Passive Debugging
+--------------------
+Passive debugging mode allows the startup of the debugger from outside
+of the IDE. The IDE waits for a connection attempt. For further details
+see the file README-passive-debugging.rst.
+
+9. Plug-in System
+-----------------
+eric6 contains a plug-in system, that is used to extend eric6's 
+functionality. Some plug-ins 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) plug-ins
+and to download them. For more details about the plug-in system
+please see the documentation area.
+
+10. Interfaces to additional software packages
+----------------------------------------------
+At the moment eric6 provides interfaces to the following software
+packages.
+
+    Qt-Designer 
+        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.
+    
+    Qt-Assistant 
+        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
+        <http://mercurial.selenic.com>. It is the one used by eric6 itself.
+    
+    Subversion 
+        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 <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 <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.
+    
+    profile 
+        This is part of the standard Python distribution and is used to profile
+        Python source code.
+
+11. Internationalization
+------------------------
+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.
+
+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.
+
+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
+the file README-eric6-doc.rst.
+
+14. 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. 
+
+15. 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.
--- a/eric6.e4p	Sun May 17 16:55:30 2015 +0200
+++ b/eric6.e4p	Mon May 25 16:28:18 2015 +0200
@@ -1699,11 +1699,11 @@
     <Other>Plugins/VcsPlugins/vcsSubversion/icons/subversion.png</Other>
     <Other>Plugins/ViewManagerPlugins/Listspace/preview.png</Other>
     <Other>Plugins/ViewManagerPlugins/Tabview/preview.png</Other>
-    <Other>README</Other>
-    <Other>README-MacOSX.txt</Other>
-    <Other>README-eric6-doc.txt</Other>
-    <Other>README-i18n.txt</Other>
-    <Other>README-passive-debugging.txt</Other>
+    <Other>README-MacOSX.rst</Other>
+    <Other>README-eric6-doc.rst</Other>
+    <Other>README-i18n.rst</Other>
+    <Other>README-passive-debugging.rst</Other>
+    <Other>README.rst</Other>
     <Other>Styles</Other>
     <Other>THANKS</Other>
     <Other>ThirdParty/CharDet/LICENSE</Other>

eric ide

mercurial