| Index: README.md |
| diff --git a/README.md b/README.md |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..6b6abc7509a9f08687386aa3420d9005a1de2b21 |
| --- /dev/null |
| +++ b/README.md |
| @@ -0,0 +1,30 @@ |
| +# Buildtools |
| + |
| +## Introduction |
| + |
| +Tools used to produce builds and releases of the Adblock Plus browser |
| +extensions. Intended to be used as a dependency by the extension repositories, |
| +not directly. |
| + |
| + |
| +## Usage |
| + |
| +Please refer to the documentation of the extension repositories for usage |
| +instructions. |
| + |
| + |
| +## Tests |
| + |
| +As per the [Python Coding Style guide](https://adblockplus.org/en/coding-style#python) |
| +this repository can be linted and tested using [Tox](https://pypi.python.org/pypi/tox). |
| + |
| +First make sure you have tox installed: |
| + |
| + sudo pip install tox |
| + |
| +Now you can lint and test the code by running the tox command: |
| + |
| + tox |
| + |
| +(Tox will take care of installing the other dependencies such as flake8 and |
| +flake8-abp inside a virtualenv when running the tests.) |