Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
en
ja
js
redpen_resources
.gitignore
.travis.yml
CONTRIBUTORS.md
LICENSE-HEADER.txt
LICENSE.txt
Makefile
README.md
en.xml
redpen-conf-ja.xml
redpen-conf.xml

README.md

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 git@github.com:redpen-cc/redpen-doc
  1. compile the user manual
    $ cd redpen-doc
    $ make html