redpen-doc

This repository is for the user manual of RedPen.

Requirements

• Asciidoctor
• rubygem-coderay

Download and Build

We download and build the manual with the following steps.

1. go to your home directory (/home/username if your account name is 'username')

    $ cd username

2. clone the source code with git command

    $ git clone git@github.com:redpen-cc/redpen-doc

3. compile the user manual

    $ cd redpen-doc
    $ make html