Skip to content

Commit 3a30169

Browse files
committed
docs: add project dependencies
1 parent 8ac41b0 commit 3a30169

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2323
- Linters can be run sooner (before installation)
2424
- Better messages when an error occurs while parsing the config file
2525
- Start converting the code to static types
26+
- Add more information about the dependencies in the documentation
2627

2728
### Fixed
2829
- Removed the lasting lint errors (i.e. in main.py)

docs/developers.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,40 @@
22

33
## Requirements
44

5+
Diffuse depends on these projects:
6+
* Python 3.8+
7+
* PyPi
8+
* Cairo and GObject Introspection development headers
9+
* Meson
10+
* Flatpak and Flatpak builder
11+
12+
### Install the distribution dependencies
13+
14+
It's a bit difficult to get the command lines for all the distributions and
15+
their releases, but it should be enough to find the packages on other
16+
distributions.
17+
18+
<details>
19+
<summary>Debian/Ubuntu</summary>
20+
21+
```sh
22+
sudo apt install python3-pip libcairo2-dev libgirepository1.0-dev meson flatpak flatpak-builder
23+
```
24+
25+
_Note: Tested on Debian 11 (Buster) and Ubuntu 20.04 (Focal)_
26+
</details>
27+
<details>
28+
<summary>Fedora</summary>
29+
30+
```sh
31+
sudo dnf install python-pip python3-cairo-devel python3-gobject-devel meson flatpak flatpak-builder
32+
```
33+
34+
_Note: Tested on Fedora 34_
35+
</details>
36+
37+
### Install the project dependencies
38+
539
To install the requirements just to execute the binary, run:
640

741
```sh

0 commit comments

Comments
 (0)