<commit_before>Building the Firefox River Trail Extension
==========================================

Preliminaries: OpenCL SDK
-------------------------

MacOS X 10.6 and later already provide the required OpenCL stack as part of the operating system. On Windows and Linux, you will need to install [the Intel OpenCL SDK] for the extension to work.

[the Intel OpenCL SDK]: https://software.intel.com/en-us/intel-opencl

Building the extension
----------------------

This extension is based on the [Firefox Add-on SDK](https://developer.mozilla.org/en-US/Add-ons/SDK).  In order to build and test the extension, first install the Add-on SDK and activate it in the extension's directory.  You can then test, run, and package the extension using the [cfx](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx) tool that comes with the Add-on SDK.<commit_msg>Update to README.md<commit_after>Building the Firefox River Trail Extension
==========================================

Preliminaries: OpenCL SDK
-------------------------

MacOS X 10.6 and later already provide the required OpenCL stack as part of the operating system. On Windows and Linux, you will need to install [the Intel OpenCL SDK] for the extension to work.

[the Intel OpenCL SDK]: https://software.intel.com/en-us/intel-opencl

Building the extension
----------------------

This extension is based on the [Firefox Add-on SDK](https://developer.mozilla.org/en-US/Add-ons/SDK).  In order to build and test the extension, first install the Add-on SDK and activate it in the Addon SDK's directory. For example, on Linux, Mac OS and MinGW on Windows:
```
cd addon-sdk
source bin/activate
```
On Windows with the native shell:
```
cd addon-sdk
bin\activate
```
You can then test, run, and package the extension using the [cfx](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx) tool that comes with the Add-on SDK.
```
cd RiverTrail/extension
cfx xpi
```
This will create an XPI file. Load this file as an addon in Firefox and try out one of the examples.
{'fraction_non_alphanumeric': 0.1633054599114609, 'fraction_numerical': 0.002951303492375799, 'mean_word_length': 3.5099778270509976, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2314403', 'n_tokens_mistral': 589, 'n_tokens_neox': 537, 'n_words': 250}