Unified Diff: README.md
Issue 29359949:
Noissue - Add README [buildtools] (Closed)
Patch Set:
Created Oct. 26, 2016, 2:59 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..1a67c73d0ce6b9d8c3a343b699c4ccb3a30048ca |
| --- /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 |
|
Vasily Kuznetsov
2016/10/26 16:15:34
Nit: period at the end of the sentence.
kzar
2016/10/26 16:24:48
Done.
|
| + |
| + |
| +## 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 install flake8, flake8-abp and tox: |
|
Vasily Kuznetsov
2016/10/26 16:15:34
It should not be necessary to install flake8 globa
kzar
2016/10/26 16:24:48
Cool. Done.
|
| + |
| + hg clone https://hg.adblockplus.org/codingtools |
| + cd codingtools |
| + sudo python setup.py install |
| + sudo pip install flake8 tox |
| + |
| +Now you can lint and test the code by running the tox command: |
| + |
| + tox |
« no previous file with comments
|
« no previous file
|
no next file »
|
no next file with comments »
