Skip to content

Commit

Permalink
add docs for setting up enchant library
Browse files Browse the repository at this point in the history
This is documented in tox.ini, too.
  • Loading branch information
dhellmann committed Jan 27, 2024
1 parent 6a7fa57 commit 4ba4ff0
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/source/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,22 @@ To run the tests, you need ``tox`` installed, then just run
``tox``. This should run the unit tests, the source code linter, and
try to build the current documentation.

Enchant C Library
-----------------

You also need the C library from Enchant installed. On macOS, use
`brew` to install the `enchant` package, then set
`PYENCHANT_LIBRARY_PATH` to point to the `dylib` file included in the
output of `brew list enchant`.

.. code-block:: console
$ brew list enchant | grep dylib
/opt/homebrew/Cellar/enchant/2.6.4/lib/libenchant-2.dylib
/opt/homebrew/Cellar/enchant/2.6.4/lib/libenchant-2.2.dylib
$ export PYENCHANT_LIBRARY_PATH=/opt/homebrew/Cellar/enchant/2.6.4/lib/libenchant-2.2.dylib
Coding style
============

Expand Down

0 comments on commit 4ba4ff0

Please sign in to comment.