<commit_before># r6maps
[![Build Status](https://travis-ci.org/capajon/r6maps.svg?branch=master)](https://travis-ci.org/capajon/r6maps)

**Hosted at http://www.r6maps.com**

r6maps.com is designed to be a quick reference for Rainbow Six Siege maps.  Please see the about.html page for more details.

## Running locally
- Install npm and install packages (npm i)
- Build scss from dev/scss to site/cs: 'npm run build:scss'
- Build js from dev/js to site/js (uglified): 'npm run build:js'
- File watches are also available (see packages.json)
- Note there are some pre reqs not listed here (to be done) - eg. sass Ruby gem

## Things to work on
Contributions are welcome. :)
<commit_msg>Changed README.md to include dependencies and update how to build the program.<commit_after># r6maps
[![Build Status](https://travis-ci.org/capajon/r6maps.svg?branch=master)](https://travis-ci.org/capajon/r6maps)

**Hosted at http://www.r6maps.com**

r6maps.com is designed to be a quick reference for Rainbow Six Siege maps.  Please see the about.html page for more details.

## Running locally

### Dependencies
- [npm/Nodejs](https://www.npmjs.com/get-npm)
    + [UglifyJS3](https://www.npmjs.com/package/uglifyjs) for cli (Try `npm install uglify-js -g`)
- [Ruby](https://www.ruby-lang.org/en/)
    + [gem](https://rubygems.org/pages/download)
    + sass (`gem install sass`)

To check the dependencies, just type `uglifyjs` or `scss`. If the program waits for input, your dependencies are installed correctly. (`uglifyjs` might already be installed from `npm install`, see below).

### Building and running
- Install npm and install packages: `npm install`
- General build: `npm run build`
    + Builds js and scss into the `site` folder. 
    + Check `package.json` for more particular scripts.
- File watches are also available (see `packages.json`)
- To run, locate `site/index.html` and open it. 

## Things to work on
Contributions are welcome. :)

{'fraction_non_alphanumeric': 0.12454966546577458, 'fraction_numerical': 0.005661348430262481, 'mean_word_length': 4.049350649350649, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 5, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '276163', 'n_tokens_mistral': 646, 'n_tokens_neox': 619, 'n_words': 223}