summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6a42298..f5278e9 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,32 @@ python-adblock
2========== 2==========
3Python wrapper for Brave's adblocking library, which is written in Rust. 3Python wrapper for Brave's adblocking library, which is written in Rust.
4 4
5### Building
6
7```
8maturin build --release
9```
10
11#### Build dependencies
12
13| Build Dependency | Versions | Arch Linux | Url |
14|------------------|----------|------------|-----|
15| Python | `>=3.6` | `python3` | - |
16| Rust | `>=1.45` | `rust` | - |
17| Maturin | `*` | `maturin` | https://github.com/PyO3/maturin |
18
19### Developing
20
21I use Poetry for development. To create and enter a virtual environment, do
22```
23poetry install
24poetry shell
25```
26then, to install the `adblock` module into the virtual environment, do
27```
28maturin develop
29```
30
5### Documentation 31### Documentation
6 32
7Rust documentation for the latest `master` branch can be found at https://arnidagur.github.io/python-adblock/docs/adblock/index.html. 33Rust documentation for the latest `master` branch can be found at https://arnidagur.github.io/python-adblock/docs/adblock/index.html.