From 9903b9ebb6bbc0f154670c6c8bb26fc980e86454 Mon Sep 17 00:00:00 2001 From: "Fletcher T. Penney" Date: Wed, 24 Aug 2016 21:44:09 -0400 Subject: [PATCH] ADDED: Support for doxygen documentation in gh-pages branch --- CMakeLists.txt | 8 ++++---- Makefile | 4 ++++ README.md | 18 +++++++++++++----- configure-gh-pages | 11 +++++++++++ templates/README.md.in | 8 ++++++++ 5 files changed, 40 insertions(+), 9 deletions(-) create mode 100755 configure-gh-pages diff --git a/CMakeLists.txt b/CMakeLists.txt index bd553c5..5d0ed63 100644 --- 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 9b7c88e..bcc835e 100644 --- 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 dac43e8..1deb882 100644 --- 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 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 ffe0eba..95fde4a 100644 --- 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