Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Unified Diff: README.md

Issue 5110636153405440: Issue 130 - Add a README.md to the adblockplus repository (Closed)
Patch Set: Did some hard wrapping after all, addressed comments Created July 18, 2014, 1:16 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: README.md
===================================================================
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+Adblock Plus for Firefox
+========================
+
+Buildling
+---------
+
+### Requirements
+
+- [Python 2.x](https://www.python.org)
+- [The Jinja2 module](http://jinja.pocoo.org/docs)
+
+### Building the extension
+
+Run the following in the project directory:
+
+ ./build.py build
+
+This will create a build with a name in the form _adblockplus-1.2.3.nnnn.xpi_.
+This file will contain the source code currently in the repository and all
+available locales.
+
+### Installing the extension automatically
+
+To simplify the process of testing your changes you can install
+[Extension Auto-Installer](https://addons.mozilla.org/addon/autoinstaller).
+Assuming that Extension Auto-Installer is configured to use port 8888
+(the default value), you can push your changes to the browser by running:
+
+ ./build.py autoinstall 8888
+
+The extension will be updated immediately.
+
+Running the unit tests
+----------------------
+
+To verify your changes you can use the existing
+[unit test suite](https://hg.adblockplus.org/adblockplustests). The unit tests
+are a separate extension that is installed in addition to Adblock Plus. You can
+either install the
+[existing unit test builds](https://adblockplus.org/devbuilds/adblockplustests)
+or clone the repository and create your own build. After installing the unit
+tests go to _chrome://adblockplustests/content/index.html_ to run the tests.
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld