From fa0be1f2fe2c5e928e48978f1a8e8c0d104a8893 Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Sun, 12 Mar 2017 20:00:41 +0100 Subject: [PATCH] Update README.rst --- README.rst | 69 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 33 deletions(-) diff --git a/README.rst b/README.rst index 3ff65ced7..9fb878693 100644 --- a/README.rst +++ b/README.rst @@ -37,32 +37,34 @@ software, released under the MIT license. 📖 Documentation ================ -+--------------------------------------------------------------------------------+---------------------------------------------------------+ -| `Usage Workflows `_   | How to use spaCy and its features.              | -+--------------------------------------------------------------------------------+---------------------------------------------------------+ -| `API Reference `_   | The detailed reference for spaCy's API. | -+--------------------------------------------------------------------------------+---------------------------------------------------------+ -| `Tutorials `_ | End-to-end examples, with code you can modify and run. | -+--------------------------------------------------------------------------------+---------------------------------------------------------+ -| `Showcase & Demos `_ | Demos, libraries and products from the spaCy community. | -+--------------------------------------------------------------------------------+---------------------------------------------------------+ -| `Contribute `_ | How to contribute to the spaCy project and code base. | -+--------------------------------------------------------------------------------+---------------------------------------------------------+ +=================== === +`Usage Workflows`_ How to use spaCy and its features. +`API Reference`_ The detailed reference for spaCy's API. +`Tutorials`_ End-to-end examples, with code you can modify and run. +`Showcase & Demos`_ Demos, libraries and products from the spaCy community. +`Contribute`_ How to contribute to the spaCy project and code base. +=================== === + +.. _Usage Workflows: https://spacy.io/docs/usage/ +.. _API Reference: https://spacy.io/docs/api/ +.. _Tutorials: https://spacy.io/docs/usage/tutorials +.. _Showcase & Demos: https://spacy.io/docs/usage/showcase +.. _Contribute: https://github.com/explosion/spaCy/blob/master/CONTRIBUTING.md 💬 Where to ask questions ========================== -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| **Bug reports**     | `GitHub Issue tracker `_                                     | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| **Usage questions**   | `StackOverflow `_, `Reddit usergroup                     | -| | `_, `Gitter chat `_ | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| **General discussion** | `Reddit usergroup `_, | -| | `Gitter chat `_  | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| **Commercial support** | contact@explosion.ai                                                                                     | -+---------------------------+------------------------------------------------------------------------------------------------------------+ +====================== === +**Bug reports** `GitHub issue tracker`_ +**Usage questions** `StackOverflow`_, `Gitter chat`_, `Reddit user group`_ +**General discussion** `Gitter chat`_, `Reddit user group`_ +**Commercial support** contact@explosion.ai +====================== === + +.. _GitHub issue tracker: https://github.com/explosion/spaCy/issues +.. _StackOverflow: http://stackoverflow.com/questions/tagged/spacy +.. _Gitter chat: https://gitter.im/explosion/spaCy +.. _Reddit user group: https://www.reddit.com/r/spacynlp Features ======== @@ -85,7 +87,7 @@ Features See `facts, figures and benchmarks `_. Top Performance -=============== +--------------- * Fastest in the world: <50ms per document. No faster system has ever been announced. @@ -94,21 +96,22 @@ Top Performance accurate systems are an order of magnitude slower or more. Supports -======== +-------- -* CPython 2.6, 2.7, 3.3, 3.4, 3.5 (only 64 bit) -* macOS / OS X -* Linux -* Windows (Cygwin, MinGW, Visual Studio) +==================== === +**Operating system** macOS / OS X, Linux, Windows (Cygwin, MinGW, Visual Studio) +**Python version** CPython 2.6, 2.7, 3.3, 3.4, 3.5. Only 64 bit. +**Package managers** `pip`_ (source packages only), `conda`_ (via ``conda-forge``) +==================== === + +.. _pip: https://pypi.python.org/pypi/spacy +.. _conda: https://anaconda.org/conda-forge/spacy Install spaCy ============= -spaCy is compatible with **64-bit CPython 2.6+/3.3+** and runs on **Unix/Linux**, -**macOS/OS X** and **Windows**. The latest spaCy releases are available over -`pip `_ (source packages only) and -`conda `_. Installation requires a working -build environment. See notes on Ubuntu, macOS/OS X and Windows for details. +Installation requires a working build environment. See notes on Ubuntu, +macOS/OS X and Windows for details. pip ---