<commit_before>ron -- the opposite of roff
===========================

## DESCRIPTION

Ron is a humane text format and toolchain for creating UNIX man
pages, and things that appear as man pages from a distance. Use it
to build and install standard UNIX roff man pages or to generate
nicely formatted HTML manual pages for the web.

The Ron file format is based on Markdown. In fact, Ron files are a
compatible subset of Markdown syntax but have a more rigid structure and
extend Markdown in some ways to provide features commonly found in man
pages (e.g., definition lists). The ron(5) manual page defines the
format in more detail.

## DOCUMENTATION

The `.ron` files located under the `man/` directory show off a wide
range of ron capabilities and are the source of Ron's own documentation.
The source files and generated HTML / roff output files are available
at:

  * [ron(1)](http://rtomayko.github.com/ron/ron.1.html) -
    build markdown based manual pages at the command line.  
    [source file](man/ron.1.ron), [roff output](man/ron.1.roff).

  * [ron(5)](http://rtomayko.github.com/ron/ron.5.html) -
    humane manual page authoring format syntax reference.  
    [source file](man/ron.5.ron), [roff output](man/ron.5.roff)

  * [markdown(5)](http://rtomayko.github.com/ron/markdown.5.html) -
    humane text markup syntax (taken from:
    <http://daringfireball.net/projects/markdown/syntax>)  
    [source file](ron/markdown.5.ron), [roff output](man/markdown.5.roff)

## INSTALL

Install with Rubygems:

    $ [sudo] gem install ron
    $ ron --help

Or, clone the git repository:

    $ git clone git://github.com/rtomayko/ron.git
    $ PATH=ron/bin:$PATH
    $ ron --help

## BASIC USAGE

To generate a roff man page from the included
[`markdown.5.ron`](man/markdown.5.ron) file and open it with man(1):

    $ ron -b man/markdown.5.ron
    building: man/markdown.5
    $ man man/markdown.5

To generate a standalone HTML version:

    $ ron -b --html man/markdown.5.ron
    building: man/markdown.5.html
    $ open man/markdown.5.html
<commit_msg>Fix links in README<commit_after>ron -- the opposite of roff
===========================

## DESCRIPTION

Ron is a humane text format and toolchain for creating UNIX man
pages, and things that appear as man pages from a distance. Use it
to build and install standard UNIX roff man pages or to generate
nicely formatted HTML manual pages for the web.

The Ron file format is based on Markdown. In fact, Ron files are a
compatible subset of Markdown syntax but have a more rigid structure and
extend Markdown in some ways to provide features commonly found in man
pages (e.g., definition lists). The ron(5) manual page defines the
format in more detail.

## DOCUMENTATION

The `.ron` files located under the `man/` directory show off a wide
range of ron capabilities and are the source of Ron's own documentation.
The source files and generated HTML / roff output files are available
at:

  * [ron(1)](http://rtomayko.github.com/ron/ron.1.html) -
    build markdown based manual pages at the command line.  
    [source file](http://github.com/rtomayko/ron/blob/master/man/ron.1.ron),
    [roff output](http://github.com/rtomayko/ron/blob/master/man/ron.1)

  * [ron(5)](http://rtomayko.github.com/ron/ron.5.html) -
    humane manual page authoring format syntax reference.  
    [source file](http://github.com/rtomayko/ron/blob/master/man/ron.5.ron),
    [roff output](http://github.com/rtomayko/ron/blob/master/man/ron.5)

  * [markdown(5)](http://rtomayko.github.com/ron/markdown.5.html) -
    humane text markup syntax (taken from
    [Markdown Syntax](http://daringfireball.net/projects/markdown/syntax),
    <NAME>)  
    [source file](http://github.com/rtomayko/ron/blob/master/man/ron.5.ron),
    [roff output](http://github.com/rtomayko/ron/blob/master/man/ron.5)

## INSTALL

Install with Rubygems:

    $ [sudo] gem install ron
    $ ron --help

Or, clone the git repository:

    $ git clone git://github.com/rtomayko/ron.git
    $ PATH=ron/bin:$PATH
    $ ron --help

## BASIC USAGE

To generate a roff man page from the included
[`markdown.5.ron`](man/markdown.5.ron) file and open it with man(1):

    $ ron -b man/markdown.5.ron
    building: man/markdown.5
    $ man man/markdown.5

To generate a standalone HTML version:

    $ ron -b --html man/markdown.5.ron
    building: man/markdown.5.html
    $ open man/markdown.5.html

{'fraction_non_alphanumeric': 0.12159709618874773, 'fraction_numerical': 0.009981851179673321, 'mean_word_length': 3.426706827309237, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, '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': '7260560', 'n_tokens_mistral': 1467, 'n_tokens_neox': 1392, 'n_words': 481}