From 3005e928e9af32fadde2347586e9569fc62bae79 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 21 Feb 2024 16:40:45 +0100 Subject: [PATCH 1/3] fix(docs): add some build instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f07ab67..fa2dd34 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 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`. From eb2c74d9446f2585f91aa0495c6f2f31c9a8276d Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 21 Feb 2024 18:48:53 +0100 Subject: [PATCH 2/3] feat: add build shortcut --- build | 3 +++ 1 file changed, 3 insertions(+) create mode 100755 build 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 From 559e651e06e1376873640433ac7976fa8fb46a7c Mon Sep 17 00:00:00 2001 From: julian-cable Date: Wed, 21 Feb 2024 17:55:44 +0000 Subject: [PATCH 3/3] Added small comment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fa2dd34..85a0d78 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Dependencies: $ sudo dnf install publican ``` -Also, follow the instructions at https://github.com/RedHatTraining/redhat-styleguide-xsl to build `publican-brand-redhat-*.noarch.rpm` and install that. +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: