Unified Diff: README.md
Issue 29359949:
Noissue - Add README [buildtools] (Closed)
Patch Set: Don't bother document how to install Tox
Created Oct. 27, 2016, 3:13 p.m.
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« no previous file
|
no next file »
|
no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| Index: README.md |
| diff --git a/README.md b/README.md |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..7678ac9f590a932dc1983a7cd9f3727f32541ea6 |
| --- /dev/null |
| +++ b/README.md |
| @@ -0,0 +1,27 @@ |
| +# 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). |
| + |
| +Once [Tox is installed](https://tox.readthedocs.io/en/latest/install.html) it's |
| +easy to lint and run the tests: |
| + |
| + tox |
| + |
| +_(Tox will take care of installing the other dependencies such as flake8 and |
| +flake8-abp inside a virtualenv.)_ |
« no previous file with comments
|
« no previous file
|
no next file »
|
no next file with comments »
