From 2f580bd958ec7e00c835ea43fa7e09a92dfb39c9 Mon Sep 17 00:00:00 2001 From: Marco Castelluccio Date: Sun, 17 May 2020 12:25:48 +0200 Subject: [PATCH] Clarify libgit2 is not always required --- README.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 18dfb644..6735d8a7 100644 --- a/README.md +++ b/README.md @@ -47,23 +47,20 @@ https://hacks.mozilla.org/2019/04/teaching-machines-to-triage-firefox-bugs/ ## Setup and Prerequisites -libgit2 (needs [v1.0.0](https://github.com/libgit2/libgit2/releases/tag/v1.0.0), only in [experimental on Debian](https://wiki.debian.org/DebianExperimental)) might be required. - -``` -sudo apt-get -t experimental install libgit2-dev -``` - -And the python dependencies: - +Install the Python dependencies: ``` pip3 install -r requirements.txt ``` - You may also need `pip install -r test-requirements.txt`. Depending on the parts of bugbug you want to run, you might need to install dependencies from other requirement files (find them with `find . -name "*requirements*"`). Currently, Python 3.7+ is required. You can double check the version we use by looking at setup.py. +Also, libgit2 (needs [v1.0.0](https://github.com/libgit2/libgit2/releases/tag/v1.0.0), only in [experimental on Debian](https://wiki.debian.org/DebianExperimental)), **might** be required (if you can't install it, skip this step). +``` +sudo apt-get -t experimental install libgit2-dev +``` + ### Auto-formatting This project is using [pre-commit](https://pre-commit.com/). Please run `pre-commit install` to install the git pre-commit hooks on your clone.