diff --git a/README.md b/README.md index f07ab67..85a0d78 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,19 @@ The Red Hat Style Guide and Word Usage Dictionary is a joint effort by vari It covers recommended design practices, how to write for translation, common mistakes to avoid, rules for everyday punctuation, grammar, and sources of information for the less common cases. It is based on The IBM Style Guide but differs in several key areas, uses the Merriam-Webster Unabridged Dictionary and American Heritage Dictionary as spelling references, and the Chicago Manual of Style (17th Ed.) for further grammatical and style decisions. + +Dependencies: + +``` +$ sudo dnf install publican +``` + +Also, follow the instructions at https://github.com/RedHatTraining/redhat-styleguide-xsl (access for Red Hat only) to build `publican-brand-redhat-*.noarch.rpm` and install that. + +To build: + +``` +$ publican build --langs=en-US --formats html +``` + +Generates `tmp/en-US/html/index.html`. diff --git a/build b/build new file mode 100755 index 0000000..b2efd20 --- /dev/null +++ b/build @@ -0,0 +1,3 @@ +#!/bin/sh + +publican build --langs en-US --formats html