@flumens/bigu/README.md

British Isles GridRef Utils

# bigu

British Isles GridRef Utils


## Initialization

### Step 1: Get the library
- Install using Bower: `bower install 'kazlauskis/bigu'` or
- Git clone: `git clone git://github.com/kazlauskis/bigu`


### Step 2: include JS files

You can find them in the root folder of the library.

```html
<!-- Add JS library file -->
<script src="path/to/bigu.min.js"></script>
```

## Building

To compile bigu by yourself make sure that you have  [Node.js](http://nodejs.org/)

- Get a copy of the source by running:

```bash
git clone git://github.com/kazlauskis/bigu.git
```

- Enter the `bigu` directory and install the npm build dependancies:

```bash
cd bigu && npm install
```

- Build the library:

```bash
npm start
```

## Authors

[Tom Humphrey](https://github.com/japonicus)
[Karolis Kazlauskis](https://github.com/kazlauskis)