<commit_before>This is a java library (API) for the YubiHSM, http://yubico.com/yubihsm

Requirements:
- RXTX, a native library providing serial and parallel communication for the Java Development Toolkit (JDK),
  http://rxtx.qbang.org/wiki/index.php/Main_Page

## How to build

    $ mvn package

to skip tests (tests require a YubiHSM configured in 'debug' mode):

    $ mvn -Dmaven.test.skip=true package


## Usage

Build the javadoc to get the API documentation.

    $ mvn javadoc:javadoc
<commit_msg>README.md: Added information on how to setup HSM for test suite<commit_after>This is a java library (API) for the YubiHSM, http://yubico.com/yubihsm

Requirements:
- RXTX, a native library providing serial and parallel communication for the Java Development Toolkit (JDK),
  http://rxtx.qbang.org/wiki/index.php/Main_Page

## How to build

    $ mvn package

to skip tests (tests require a YubiHSM configured in 'debug' mode):

    $ mvn -Dmaven.test.skip=true package

## How to configure HSM in debug mode
The HSM is a serial device, I recommend using screen to connect with the device (ie screen /dev/ttyACM0).

Prepare the HSM as follows:
    zap
    yes
    hsm ffffffff
    <enter>
    <enter>
    <enter>
    yes
    exit
    yes

## Usage

Build the javadoc to get the API documentation.

    $ mvn javadoc:javadoc

{'fraction_non_alphanumeric': 0.07900677200902935, 'fraction_numerical': 0.0007524454477050414, 'mean_word_length': 3.448160535117057, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 1, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4343277', 'n_tokens_mistral': 459, 'n_tokens_neox': 427, 'n_words': 164}