Skip to content
Snippets Groups Projects
Commit 514290c5 authored by Nico's avatar Nico
Browse files

Link to wrapper.docs.briarproject.org

parent e851a46c
Loading
Pipeline #4744 passed
......@@ -14,6 +14,12 @@ The easiest way to install Briar Wrapper is to
install [the package from PyPi.org](https://pypi.org/project/briar_wrapper/):
`pip install briar_wrapper`
## Documentation
The documentation of the project can be found at
[wrapper.docs.briarproject.org](https://wrapper.docs.briarproject.org/).
To generate it locally, call `tools/generate-docs.sh`.
## Building
You can also build it yourself by runninng the following command:
......@@ -59,11 +65,6 @@ And install the .deb like this:
sudo dpkg -i ../python3-briar-wrapper_0.0.3-1_all.deb
```
## Documentation
The documentation of the project's code can be found in the _docs_ directory.
To generate it, call `tools/generate-docs.sh`.
## Design Goals
* Main platform is GNU/Linux, but should also support (at least) Windows and macOS
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment