Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 659 Bytes

README.md

File metadata and controls

35 lines (24 loc) · 659 Bytes

Build Status

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
  1. clone the source code with git command
    $ git clone [email protected]:redpen-cc/redpen-doc
  1. compile the user manual
    $ cd redpen-doc
    $ make html