<commit_before>LLNMS
=====

Low-Level Network Management System

Overview
--------
A network management system designed to operate as an independent collection
of utilities merged into a cohesive NMS solution.

Commands
--------

LLNMS does everything through a set of command-line tools.  Commands to run the LLNMS suite
are generally defined as llnms-**action**-**target**.  

###  Network Management




###  Asset Management

To create an asset, 

    llnms-create-asset

To remove an asset,

    llnms-remove-asset
 


###  LLNMS-Viewer

LLNMS-Viewer is a command-line application designed to make using LLNMS easier.  It is
designed with ncurses to allow for use when logged via ssh or another network protocol. To
run, type

    llnms-viewer



Installation
------------

### Linux (shell)
Most Linux systems contain a basic shell system.  For 
most this will be Bash or Dash (Ubuntu).  To install, 
run the script from the base directory.

    ./install/bash/install.sh

run with -h or -help for more options.

The primary installation option is the destination for `LLNMS_HOME` which 
should be defaulted to `/var/tmp/llnms`.  Given this installation destination,
all components will be installed there. 


### Windows (PowerShell)
Windows 7 and later ship with Windows PowerShell.


Building and Unit-Testing
-------------------------

###  Linux (shell)
LLNMS comes with a full unit-test suite for both LLNMS and LLNMS-Viewer.  To do a complete setup and build, read the documentation at docs/overview/overview.pdf.

In general, this is the recommended process. 

First, install LLNMS

    ./install/bash/install -n

Next, build LLNMS-Viewer and install

    ./install/cpp/install make install

Next, run the llnms unit test suite.  You should have complete passes or else there is a bug.

    ./test/run_tests.sh

Finally, run the llnms-viewer unit-test suite.  You should have complete passes or else there is a bug.
    
    ./release/llnms-viewer-unit-test


<commit_msg>fixing location of unit test in readme<commit_after>LLNMS
=====

Low-Level Network Management System

Overview
--------
A network management system designed to operate as an independent collection
of utilities merged into a cohesive NMS solution.

Commands
--------

LLNMS does everything through a set of command-line tools.  Commands to run the LLNMS suite
are generally defined as llnms-**action**-**target**.  

###  Network Management




###  Asset Management

To create an asset, 

    llnms-create-asset

To remove an asset,

    llnms-remove-asset
 


###  LLNMS-Viewer

LLNMS-Viewer is a command-line application designed to make using LLNMS easier.  It is
designed with ncurses to allow for use when logged via ssh or another network protocol. To
run, type

    llnms-viewer



Installation
------------

### Linux (shell)
Most Linux systems contain a basic shell system.  For 
most this will be Bash or Dash (Ubuntu).  To install, 
run the script from the base directory.

    ./install/bash/install.sh

run with -h or -help for more options.

The primary installation option is the destination for `LLNMS_HOME` which 
should be defaulted to `/var/tmp/llnms`.  Given this installation destination,
all components will be installed there. 


### Windows (PowerShell)
Windows 7 and later ship with Windows PowerShell.


Building and Unit-Testing
-------------------------

###  Linux (shell)
LLNMS comes with a full unit-test suite for both LLNMS and LLNMS-Viewer.  To do a complete setup and build, read the documentation at docs/overview/overview.pdf.

In general, this is the recommended process. 

First, install LLNMS

    ./install/bash/install -n

Next, build LLNMS-Viewer and install

    ./install/cpp/install make install

Next, run the llnms unit test suite.  You should have complete passes or else there is a bug.

    ./test/bash/run_tests.sh

Finally, run the llnms-viewer unit-test suite.  You should have complete passes or else there is a bug.
    
    ./release/llnms-viewer-unit-test



{'fraction_non_alphanumeric': 0.08970514742628685, 'fraction_numerical': 0.0004997501249375312, 'mean_word_length': 3.1098562628336754, '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': '1129864', 'n_tokens_mistral': 1198, 'n_tokens_neox': 1117, 'n_words': 510}