<commit_before># node-db-nuodb: NuoDB database bindings for Node.js #

For detailed information about this and other Node.js
database bindings visit the [Node.js db-nuodb homepage] [homepage].

## REQUIREMENTS

It turns out that node-db does not support 0.8.* and later versions of Node.js. As such to build and test you must install an earlier version of
Node.js. We suggest 0.6.9:

[Node.js 0.6.9] [node.js v0.6.9]

Make sure to install nodeunit globally:

```bash
npm install nodeunit -g
```

## BUILDING ##

```bash
git submodule update --init

export PATH=/usr/local/bin:$PATH
export NODE_PATH=/usr/local/bin/node
export NUODB_INCLUDE_DIR=/opt/nuodb/include
export NUODB_LIB_DIR=/opt/nuodb/lib64

node-waf configure && node-waf clean build test
```

In order to run tests you should start NuoDB using the settings specified in
the test-settings.json file.

If you opt to install Node.js on Mac using a .pkg file, you will need to build thusly:

```bash
sudo NUODB_LIB_DIR=/Users/rbuck/tmp/nuodb/lib64 NUODB_INCLUDE_DIR=/Users/rbuck/tmp/nuodb/include PATH=$PATH:/usr/local/bin npm install . -g
```

## INSTALL ##

Before proceeding with installation, you need to have NuoDB installed;
the examples below assume an installation location of /opt/nuodb, but
the location may vary.

In order for the installation script to locate dependencies properly, you'll 
need to set the NUODB_INCLUDE_DIR and NUODB_LIB_DIR environment variables. 
For example:<commit_msg>Doc tagging.<commit_after># node-db-nuodb: NuoDB database bindings for Node.js #

For detailed information about this and other Node.js
database bindings visit the [Node.js db-nuodb homepage] [homepage].

## REQUIREMENTS

It turns out that node-db does not support 0.8.* and later versions of Node.js. As such to build and test you must install an earlier version of
Node.js. We suggest 0.6.9:

[Node.js 0.6.9] [node.js v0.6.9]

Make sure to install nodeunit globally:

```bash
npm install nodeunit -g
```

## BUILDING ##

```bash
git submodule update --init

export PATH=/usr/local/bin:$PATH
export NODE_PATH=/usr/local/bin/node
export NUODB_INCLUDE_DIR=/opt/nuodb/include
export NUODB_LIB_DIR=/opt/nuodb/lib64

node-waf configure && node-waf clean build test
```

In order to run tests you should start NuoDB using the settings specified in
the test-settings.json file.

If you opt to install Node.js on Mac using a .pkg file, you will need to build thusly:

```bash
sudo NUODB_LIB_DIR=/Users/rbuck/tmp/nuodb/lib64 NUODB_INCLUDE_DIR=/Users/rbuck/tmp/nuodb/include PATH=$PATH:/usr/local/bin npm install . -g
```

## RELEASE PROCEDURE ##

### TAGGING ###

Tag the product using tags per the SemVer specification; our tags have a v-prefix:

```bash
git tag -a v1.0.0-rc.1 -m "SemVer Version: v1.0.0-rc.1"
```

If you make a mistake, take it back quickly:

```bash
git tag -d v1.0.0-rc.1
git push origin :refs/tags/v1.0.0-rc.1
```

## INSTALL ##

Before proceeding with installation, you need to have NuoDB installed;
the examples below assume an installation location of /opt/nuodb, but
the location may vary.

In order for the installation script to locate dependencies properly, you'll 
need to set the NUODB_INCLUDE_DIR and NUODB_LIB_DIR environment variables. 
For example:
{'fraction_non_alphanumeric': 0.0966944701884461, 'fraction_numerical': 0.01421068890948409, 'mean_word_length': 4.1808, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '5273545', 'n_tokens_mistral': 1164, 'n_tokens_neox': 1057, 'n_words': 404}