Add simple jazzy.sh script

beltex · Dec 19, 2014 · a0a987e · a0a987e · beltex · Dec 24, 2014
1 parent ce09867
commit a0a987e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,21 +1,10 @@
 IGNORE THIS BRANCH
-====
+==================
 
 This is the [GitHub Pages](https://pages.github.com) branch for the project,
 used to host the assets (API doc, etc.) that are linked in the master branch
 README.md
 
 ### [jazzy](https://github.com/realm/jazzy)
 
-jazzy is used to generate the API document for SMCKit.
-
-- Version in use: **0.0.16**
-
-```bash
-# Command used to generate doc
-jazzy -a beltex
-      -u https://github.com/beltex/
-      -m SMCKit
-      -g http://github.com/beltex/SMCKit
-      -x -project,SMCKit.xcodeproj
-```
+jazzy is used to generate the API document for SMCKit. See `jazzy.sh`.
diff --git a/jazzy.sh b/jazzy.sh
@@ -0,0 +1,9 @@
+#!/bin/bash
+# WHAT: Script to generate API document using jazzy (v0.0.17)
+
+AUTHOR=beltex
+AUTHOR_URL=https://github.com/beltex/
+MODULE_NAME=SMCKit
+GITHUB_URL=http://github.com/beltex/SMCKit
+
+jazzy -a $AUTHOR -u $AUTHOR_URL -m $MODULE_NAME -g $GITHUB_URL