From 3a3016937cd66b57806f2a6ffa223003fd48f9d6 Mon Sep 17 00:00:00 2001 From: Romain Failliot Date: Sun, 9 Jan 2022 10:41:30 -0500 Subject: [PATCH] docs: add project dependencies --- CHANGELOG.md | 1 + docs/developers.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f33b9f..f876b78 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Linters can be run sooner (before installation) - Better messages when an error occurs while parsing the config file - Start converting the code to static types +- Add more information about the dependencies in the documentation ### Fixed - Removed the lasting lint errors (i.e. in main.py) diff --git a/docs/developers.md b/docs/developers.md index d8acd9f..8fcceb9 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -2,6 +2,40 @@ ## Requirements +Diffuse depends on these projects: +* Python 3.8+ +* PyPi +* Cairo and GObject Introspection development headers +* Meson +* Flatpak and Flatpak builder + +### Install the distribution dependencies + +It's a bit difficult to get the command lines for all the distributions and +their releases, but it should be enough to find the packages on other +distributions. + +
+ Debian/Ubuntu + +```sh +sudo apt install python3-pip libcairo2-dev libgirepository1.0-dev meson flatpak flatpak-builder +``` + +_Note: Tested on Debian 11 (Buster) and Ubuntu 20.04 (Focal)_ +
+
+ Fedora + +```sh +sudo dnf install python-pip python3-cairo-devel python3-gobject-devel meson flatpak flatpak-builder +``` + +_Note: Tested on Fedora 34_ +
+ +### Install the project dependencies + To install the requirements just to execute the binary, run: ```sh