move documentation to csb-toolbox.github.io

INSTALL.rst

@@ -1,89 +1,3 @@
+Detailed installation instructions can be found here:
 
-
-System Requirements
--------------------
-
-CSB is distributed as a pure python package, which renders it cross-platform.
-Installation is therefore a very trivial task. The source code is also kept
-compatible across python versions, so we guarantee that every official release
-package will work on both python 2 and 3 without any change. We test all nightly
-builds against python versions 2.7 and 3.2, but technically CSB supports python 2.6
-and all subsequent versions except probably 3.0.
-
-
-User Installation
------------------
-
-Install csb from PyPi::
-
-    $ pip install csb
-
-pip will take care of all necessary dependencies. However, on Windows this might
-fail. If this is the case, install numpy and scipy manually and rerun the pip
-installation shown above. The easiest way to get numpy and scipy on Windows is 
-to install Anaconda::
-
-    $ conda install numpy scipy
-    $ pip install csb
-
-
-Developer Installation
-----------------------
-
-ABOUT DEPENDENCIES
-
-CSB depends on 2 very well-known and readily available python packages:
-
-* numpy - required (numpy.scipy.org)
-* scipy - required (scipy.org)
-* matplotlib and wxPython - optional, needed only if you want to use csb.io.plots
-
-On python 2.6 you will need these two as well:
-
-* unittest2
-* argparse
-
-both of which are standard, simple and available for download from PyPi (pypi.python.org).
-
-Epydoc is required to build the API documentation.
-
-
-INSTALLATION
-
-First get the source code from github::
-
-    $ git clone https://github.com/csb-toolbox/CSB.git
-    $ cd CSB
-
-Then install the project in editable mode::
-
-    $ pip install --editable .[dev]
-
-pip will take care of all runtime and development dependencies and make the source
-code location importable. No need to modify your $PYTHONPATH.
-
-If dependencies cannot be resolved on your system - this is often the case on
-Windows - the best way to go from here is to install Anaconda. Then use the conda
-package manager to install all missing packages::
-
-    $ conda install --file requirements.txt
-    $ pip install --editable .[dev]
-
-
-
-Testing
--------
-
-Running the CSB test suite may be useful in order to check if your installation works.
-All CSB tests are executed with the csb.test.Console. A typical way to run the console is::
-
-    $ csb-test "csb.test.cases.*"
-
-
-API Documentation
------------------
-
-CSB comes with API docs in HTML format. Simply navigate to the docs/api folder in the
-release package and open index.html with any web browser. Note that the docs are not
-installed, so you need to keep your own copy.
-
+http://csb-toolbox.github.io/Installation

README.rst

@@ -19,8 +19,8 @@ package consists of a few major components:
 
 Installation 
 ------------
-CSB is being developed on Linux with Python 2.7. However, compatibility
-is a design goal and the package works on any platform, on any modern python
+CSB is being developed on Linux with Python 2.7 and 3.6. However, compatibility
+is a design goal and the package works on any platform, on any modern Python
 interpreter since version 2.6 (that includes python 3 support out of
 the box). If you find any issues on a platform/interpreter different from
 our development environment, please let us know.
@@ -29,6 +29,8 @@ CSB and all of its dependencies can be installed with pip::
 
     $ pip install csb
 
+See http://csb-toolbox.github.io/Installation for more details.
+
 
 Running CSB Applications
 ------------------------
@@ -47,13 +49,13 @@ Documentation
 -------------
 
 The project's web site at `GitHub <http://github.com/csb-toolbox>`_ contains
-online documentation and samples. Be sure to check out:
+online documentation and samples. Visit us at:
 
-http://csb-toolbox.github.io/CSB
+http://csb-toolbox.github.io
 
 Detailed API documentation can be found in the "docs/api" directory in the
 distribution package (docs/api/index.html). This documentaiton is also hosted
-on PyPi:
+on our web site:
 
 https://csb-toolbox.github.io/api-docs/
 
@@ -79,7 +81,7 @@ CSB is developed by Michael Habeck's Computational Structural Biology
 For complete source code, contributions, support or bug reports please visit
 us on GitHub:
 
-http://github.com/csb-toolbox/CSB
+http://github.com/csb-toolbox/
 
 
 License