Clarify libgit2 is not always required

This commit is contained in:
Marco Castelluccio 2020-05-17 12:25:48 +02:00
Родитель e5193fd09a
Коммит 2f580bd958
1 изменённых файлов: 6 добавлений и 9 удалений

Просмотреть файл

@ -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.