<commit_before># NinjaCalc

#### An embedded engineering calculator suite for doing calculations in a breeze.

- Author: gbmhunter <<EMAIL>> ([www.mbedded.ninja](http://www.mbedded.ninja))
- Created: 2015-11-02
- Last Modified: 2017-03-09
- Version: v2.0.0
- Company: mbedded.ninja
- Project: NinjaTerm
- Language: Javascript (vue.js)/HTML/CSS
- IDE: WebStorm
- Documentation Format: JSDoc
- License: GPLv3

# Motivation

The goal of this is to provide a easy-to-use web application to help you with all those small, frequent calculations you do while doing embedded engineering (or other forms of engineering). Whether it be a low-pass LC filter, a resistor divider, trying to find PCB track current, or even just Ohm's law (o.k., I hope you don't forget that one, but it is included none-the-less), this app makes them easy to find, use, and have confidence in the answers.

# To Use

Go to http://ninja-calc.mbedded.ninja/

# Features

See the [project home page](http://mbedded-ninja.github.io/NinjaCalc/) for a list of features.

# Developing

1. Download/clone this repository into a folder on your computer.
1. Run `npm install` to install dependencies (make sure node/npm is installed on your system).
1. Open the project in WebStorm (`.idea/workspace.xml` file included in repo), or your favourite text/code editor.
1. Develop!

# Releasing

1. Make sure you are on the `develop` branch and all changes from `feature/xxx` branches have been merged into it.
1. Update `changelog.md` with a list of changes since the last release, under a heading which is the new version number (e.g. `v1.2.0`).
1. Commit the changes made above to the `develop` branch.
1. Merge the `develop` branch into the `master` branch. **MAKE SURE** that you create a new commit while doing this, even if fast-forward is possible.
1. Tag the commit on the master branch with the version number (e.g. `v1.2.0`).
1. Push all branches to the remote GitHub repo.
1. To deploy the new files, firstly run `npm install`. This will create production files in the `dist/` directory.
1. Run `./deploy.sh`. This will copy the production files from `dist/` to the remote server. Note: SSH authentication is required for this work (currently only <EMAIL> can do this step).

# Changelog

See [changelog.md](../blob/master/changelog.md).

# Contributors

See the [project home page](http://mbedded-ninja.github.io/NinjaCalc/) for a list of contributors.<commit_msg>Fixed deployment instruction errors in README.<commit_after># NinjaCalc

#### An embedded engineering calculator suite for doing calculations in a breeze.

- Author: gbmhunter <<EMAIL>> ([www.mbedded.ninja](http://www.mbedded.ninja))
- Created: 2015-11-02
- Last Modified: 2017-03-09
- Version: v2.0.0
- Company: mbedded.ninja
- Project: NinjaTerm
- Language: Javascript (vue.js)/HTML/CSS
- IDE: WebStorm
- Documentation Format: JSDoc
- License: GPLv3

# Motivation

The goal of this is to provide a easy-to-use web application to help you with all those small, frequent calculations you do while doing embedded engineering (or other forms of engineering). Whether it be a low-pass LC filter, a resistor divider, trying to find PCB track current, or even just Ohm's law (o.k., I hope you don't forget that one, but it is included none-the-less), this app makes them easy to find, use, and have confidence in the answers.

# To Use

Go to http://ninja-calc.mbedded.ninja/

# Features

See the [project home page](http://mbedded-ninja.github.io/NinjaCalc/) for a list of features.

# Developing

1. Download/clone this repository into a folder on your computer.
1. Run `npm install` to install dependencies (make sure node/npm is installed on your system).
1. Open the project in WebStorm (`.idea/workspace.xml` file included in repo), or your favourite text/code editor.
1. Develop!

# Releasing

1. Make sure you are on the `develop` branch and all changes from `feature/xxx` branches have been merged into it.
1. Update `changelog.md` with a list of changes since the last release, under a heading which is the new version number (e.g. `v1.2.0`).
1. Commit the changes made above to the `develop` branch.
1. Merge the `develop` branch into the `master` branch. **MAKE SURE** that you create a new commit while doing this, even if fast-forward is possible.
1. Tag the commit on the master branch with the version number (e.g. `v1.2.0`).
1. Push all branches to the remote GitHub repo.
1. To deploy the new files, firstly run `npm run build`. This will create production files in the `dist/` directory.
1. Run `./deploy.sh` (from a UNIX-style shell, e.g. Linux, cygwin, MinGW). This will copy the production files from `dist/` to the remote server. Note: SSH authentication is required for this work (currently only <EMAIL> can do this step).

# Changelog

See [changelog.md](../blob/master/changelog.md).

# Contributors

See the [project home page](http://mbedded-ninja.github.io/NinjaCalc/) for a list of contributors.
{'fraction_non_alphanumeric': 0.09592084006462036, 'fraction_numerical': 0.015347334410339256, 'mean_word_length': 3.948051948051948, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 4, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3030731', 'n_tokens_mistral': 1548, 'n_tokens_neox': 1456, 'n_words': 699}