From cbab7cc560e56491bcd64cd2fb7fd84a4876227d Mon Sep 17 00:00:00 2001 From: Olivier Grisel <olivier.grisel@ensta.org> Date: Fri, 6 May 2011 08:21:50 -0700 Subject: [PATCH] Compressed README.rst to make it an executive summary --- README.rst | 44 ++++++++++---------------------------------- 1 file changed, 10 insertions(+), 34 deletions(-) diff --git a/README.rst b/README.rst index 854da218d5..17f285941b 100644 --- a/README.rst +++ b/README.rst @@ -13,13 +13,16 @@ the AUTHORS.rst file for a complete list of contributors. It is currently maintained by a team of volunteers. -Download -======== - -You can download source code and Windows binaries from SourceForge: - -http://sourceforge.net/projects/scikit-learn/files/ +Important links +=============== +- Official source code repo: https://github.com/scikit-learn/scikit-learn +- HTML documentation (stable release): http://scikit-learn.sourceforge.net/ +- HTML documentation (development version): http://scikit-learn.sourceforge.net/dev/ +- Download releases: http://sourceforge.net/projects/scikit-learn/files/ +- Issue tracker: https://github.com/scikit-learn/scikit-learn/issues +- Mailing list: https://lists.sourceforge.net/lists/listinfo/scikit-learn-general +- IRC channel: ``#scikit-learn`` at ``irc.freenode.net`` Dependencies ============ @@ -44,23 +47,6 @@ To install for all users on Unix/Linux:: sudo python setup.py install -Mailing list -============ - -There's a general and development mailing list, visit -https://lists.sourceforge.net/lists/listinfo/scikit-learn-general to -subscribe to the mailing list. - - -IRC channel -=========== - -Some developers tend to hang around the channel ``#scikit-learn`` -at ``irc.freenode.net``, especially during the week preparing a new -release. If nobody is available to answer your questions there don't -hesitate to ask it on the mailing list to reach a wider audience. - - Development =========== @@ -78,13 +64,6 @@ or if you have write privileges:: git clone git@github.com:scikit-learn/scikit-learn.git -Bugs ----- - -Please submit bugs you might encounter, as well as patches and feature -requests to the tracker located at github -https://github.com/scikit-learn/scikit-learn/issues - Testing ------- @@ -95,7 +74,4 @@ source directory (you will need to have nosetest installed):: python -c "import scikits.learn as skl; skl.test()" See web page http://scikit-learn.sourceforge.net/install.html#testing -for more information. - - - +for more information. \ No newline at end of file -- GitLab