ADDED: Support for doxygen documentation in gh-pages branch

diff --git a/CMakeLists.txt b/CMakeLists.txt
index bd553c51abbba7910513265b40739888c38d6793..5d0ed634b92a8bc9a6d6e6c0e5d2452445448c49 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -5,13 +5,13 @@ cmake_minimum_required (VERSION 2.6)
 # Define Our Project
 # ==================
 
-set (My_Project_Title "Some Project")
-set (My_Project_Description "A project built using the c-template system.")
+set (My_Project_Title "C-Template")
+set (My_Project_Description "Boilerplate c project with cmake support, CuTest unit testing, and more.")
 set (My_Project_Author "Fletcher T. Penney")
-set (My_Project_Revised_Date "2016-05-06")
+set (My_Project_Revised_Date "2016-08-24")
 set (My_Project_Version_Major 1)
 set (My_Project_Version_Minor 0)
-set (My_Project_Version_Patch 2)
+set (My_Project_Version_Patch 3)
 
 set (My_Project_Version "${My_Project_Version_Major}.${My_Project_Version_Minor}.${My_Project_Version_Patch}")
 

diff --git a/Makefile b/Makefile
index 9b7c88e814f2669d7bc355b34080850572035a86..bcc835e7ea320b0ea67d4488224994adf0607dde 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -67,6 +67,10 @@ documentation: $(BUILD_DIR)
        cmake -DDOCUMENTATION=1 ..; cd ..; \
        doxygen build/doxygen.conf
 
+.PHONY : gh-pages
+gh-pages: documentation
+       cp -r $(BUILD_DIR)/documentation/html/* documentation/
+
 # Clean out the build directory
 .PHONY : clean
 clean:

diff --git a/README.md b/README.md
index dac43e81793c110404db36000815ccc381f3f9ac..1deb88279d86e866cad14270826fde64aee1a0c9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,11 +2,11 @@
 
 |            |                           |  
 | ---------- | ------------------------- |  
-| Title:     | Some Project        |  
-| Author:    | Somebody       |  
-| Date:      | 2015-06-05 |  
-| Copyright: | Copyright © 2015 Somebody.    |  
-| Version:   | 1.0.1      |  
+| Title:     | C-Template        |  
+| Author:    | Fletcher T. Penney       |  
+| Date:      | 2016-08-24 |  
+| Copyright: | Copyright © 2015-2016 Fletcher T. Penney.    |  
+| Version:   | 1.0.3      |  
 
 
 ## Introduction ##
@@ -148,6 +148,14 @@ Properly configuring your source for this is up to you.  You can modify the
 of the basics are handled for you based on your CMake configuration.
 
 
+### GitHub Pages Support ###
+
+The `configure-gh-pages` script sets up a `documentation` directory that is 
+linked to a `gh-pages` branch of the project.  You can then run `make gh-pages` 
+to update the documentation in this directory.  Commit and push to your origin,
+and your projects gh-page is updated.
+
+
 ### Makefile ###
 
 The overall build process is controlled by the master `Makefile`.  It provides

diff --git a/configure-gh-pages b/configure-gh-pages
new file mode 100755 (executable)
index 0000000..1b1303d
--- /dev/null
+++ b/configure-gh-pages
@@ -0,0 +1,11 @@
+#!/bin/sh
+
+mkdir documentation
+
+cd documentation
+
+git clone .. .
+
+git checkout --orphan gh-pages
+
+git rm -rf .

diff --git a/templates/README.md.in b/templates/README.md.in
index ffe0eba01b5e3ad671624551130c9e28049646c5..95fde4a62d29c903f4dd1c3d5f6cf89eb923bb2e 100644 (file)
--- a/templates/README.md.in
+++ b/templates/README.md.in
@@ -148,6 +148,14 @@ Properly configuring your source for this is up to you.  You can modify the
 of the basics are handled for you based on your CMake configuration.
 
 
+### GitHub Pages Support ###
+
+The `configure-gh-pages` script sets up a `documentation` directory that is 
+linked to a `gh-pages` branch of the project.  You can then run `make gh-pages` 
+to update the documentation in this directory.  Commit and push to your origin,
+and your projects gh-page is updated.
+
+
 ### Makefile ###
 
 The overall build process is controlled by the master `Makefile`.  It provides