From d79a28a4c255f9590bb7f10e7860cee39a8b61dd Mon Sep 17 00:00:00 2001 From: bbhtt Date: Fri, 28 Jun 2024 19:50:07 +0530 Subject: [PATCH] README: Document dependencies --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 35c5efb3..bdc2050f 100644 --- a/README.md +++ b/README.md @@ -40,12 +40,20 @@ not recommended unless for development purposes. It depends on patches that are found in the `org.flatpak.Builder` flatpak package and on external tools. +For development purposes it can be installed with: + ```bash git clone https://github.com/flathub/flatpak-builder-lint cd flatpak-builder-lint poetry install poetry run flatpak-builder-lint --help ``` + +The following Python dependencies are needed to run +`jsonschema==4.19.1, requests==2.32.2, lxml==5.2.2, sentry-sdk==1.34.0, +PyGObject==3.46.0`. Additionally `poetry-core>=1.0.0` is necessary +to build. + Additional tools are required by subcommands and checks: - `flatpak-builder` for validating flatpak-builder manifests