Skip to content

Commit

Permalink
Removed mentions of setup.py install and XEdDSA's system library requ…
Browse files Browse the repository at this point in the history
…irements
  • Loading branch information
Syndace committed Nov 8, 2022
1 parent cc6009b commit c1fdb00
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ A complete implementation of [XEP-0384](https://xmpp.org/extensions/xep-0384.htm

## Installation ##

python-omemo depends on two system libraries, [libxeddsa](https://github.com/Syndace/libxeddsa)>=2,<3 and [libsodium](https://download.libsodium.org/doc/).

Install the latest release using pip (`pip install OMEMO`) or manually from source by running `pip install .` (recommended) or `python setup.py install` in the cloned repository. The installation requires libsodium and the Python development headers to be installed. If a locally installed version of libxeddsa is available, [python-xeddsa](https://github.com/Syndace/python-xeddsa) (a dependency of python-omemo) tries to use that. Otherwise it uses prebuilt binaries of the library, which are available for Linux, MacOS and Windows for the amd64 architecture, and potentially for MacOS arm64 too. Set the `LIBXEDDSA_FORCE_LOCAL` environment variable to forbid the usage of prebuilt binaries.
Install the latest release using pip (`pip install OMEMO`) or manually from source by running `pip install .` in the cloned repository.

## Testing, Type Checks and Linting ##

Expand Down
4 changes: 1 addition & 3 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
Installation
============

python-omemo depends on two system libraries, `libxeddsa <https://github.com/Syndace/libxeddsa>`__>=2,<3 and `libsodium <https://download.libsodium.org/doc/>`__.

Install the latest release using pip (``pip install OMEMO``) or manually from source by running ``pip install .`` (preferred) or ``python setup.py install`` in the cloned repository. The installation requires libsodium and the Python development headers to be installed. If a locally installed version of libxeddsa is available, `python-xeddsa <https://github.com/Syndace/python-xeddsa>`__ (a dependency of python-omemo) tries to use that. Otherwise it uses prebuilt binaries of the library, which are available for Linux, MacOS and Windows for the amd64 architecture, and potentially for MacOS arm64 too. Set the ``LIBXEDDSA_FORCE_LOCAL`` environment variable to forbid the usage of prebuilt binaries.
Install the latest release using pip (``pip install OMEMO``) or manually from source by running ``pip install .`` in the cloned repository.

0 comments on commit c1fdb00

Please sign in to comment.