<commit_before>
# installation

## default

The **default** setup installs the library and executable at `${HOME}/bin`.

**benefits:**

* allows installing without requiring `sudo`


**caveats:**

* installs the utils only for the current user. Other users will have to install on their own


## custom

Installation has been made simple by using environment variables. To change the directory to put the library in, say `/usr/lib/`, you use the `LIB` variable.

To change the directory to put the executable in, say `/usr/bin/`, you use the `BIN` variable.

By default, the latest build of `msu` is downloaded and installed. To install a specific build version, use the `${BUILD}` variable, say `9482e161c974bc0cebf823fc0fe8a3caed14a8a0`. This is useful for debugging purposes and rollbacks.

As an example, *(using all variables. you can use one or more)*

```bash
⇒ wget -qO- http://git.io/vTE0s | LIB=/usr/lib BIN=/usr/bin/ BUILD=9482e161c974bc0cebf823fc0fe8a3caed14a8a0 bash
```
<commit_msg>(docs) update docs on different methods of installation<commit_after>
# installation

## methods:

There are different ways of installing `msu`.

1. **automated install**

  ```bash
  ⇒ wget -qO- http://git.io/vTE0s | bash
  ```

  This downloads the `get.sh` script in the repo and runs it using **bash**. It's easier and faster.

1. **manual install**

  ```bash
  ⇒ git clone https://github.com/GochoMugo/msu.git
  ⇒ cd msu/
  ⇒ ./install.sh
  ```

  You clone this repo and run the `install.sh` script. This method is preferable if you will be hacking on `msu`.


## default setup:

The **default** setup installs the library at `${HOME}/lib` and the executable at `${HOME}/bin`.

**benefits:**

* allows installing without requiring `sudo`


**caveats:**

* installs the utils only for the current user. Other users will have to install on their own


## custom setup:

Installation has been made simple by using environment variables. To change the directory to put the library in, say `/usr/lib/`, you use the `LIB` variable.

To change the directory to put the executable in, say `/usr/bin/`, you use the `BIN` variable.

By default, the latest build of `msu` is downloaded and installed. To install a specific build version, use the `${BUILD}` variable, say `9482e161c974bc0cebf823fc0fe8a3caed14a8a0`. This is useful for debugging purposes and rollbacks.

> Use of `${BUILD}` is **not** applicable to manual installs.

As an example, *(using all variables. you can use one or more variables)*

```bash
⇒ wget -qO- http://git.io/vTE0s | LIB=/usr/lib BIN=/usr/bin/ BUILD=9482e161c974bc0cebf823fc0fe8a3caed14a8a0 bash # automated install
⇒ LIB=/usr/lib BIN=/usr/bin/ ./install.sh # manual install
```

{'fraction_non_alphanumeric': 0.11098779134295228, 'fraction_numerical': 0.032926378098409176, 'mean_word_length': 4.121212121212121, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 3, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '877763', 'n_tokens_mistral': 917, 'n_tokens_neox': 863, 'n_words': 359}