diff options
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/getting-started.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst index 4337b47c..f5d6c190 100644 --- a/docs/development/getting-started.rst +++ b/docs/development/getting-started.rst @@ -2,10 +2,10 @@ Getting started =============== Working on ``cryptography`` requires the installation of a small number of -development dependencies in addition to the dependencies for :doc:`/installation`. -These are listed in ``dev-requirements.txt`` and they can be installed in a -`virtualenv`_ using `pip`_. Once you've installed the dependencies, install -``cryptography`` in ``editable`` mode. For example: +development dependencies in addition to the dependencies for +:doc:`/installation`. These are listed in ``dev-requirements.txt`` and they can +be installed in a `virtualenv`_ using `pip`_. Once you've installed the +dependencies, install ``cryptography`` in ``editable`` mode. For example: .. code-block:: console @@ -13,6 +13,9 @@ These are listed in ``dev-requirements.txt`` and they can be installed in a $ pip install --requirement dev-requirements.txt $ pip install --editable . +You will also need to install ``enchant`` using your system's package manager +to check spelling in the documentation. + You are now ready to run the tests and build the documentation. Running tests |