Merge pull request #9 from mrhatch97/dev

Doxyfile fixes, updated README

Author: mrhatch97

.gitlab-ci.yml

@@ -7,6 +7,7 @@ before_script:
 stages:
     - build
     - test
+    - post
 
 build:
     stage: build
@@ -27,6 +28,7 @@ test:
         - build
 
 pages:
+    stage: post
     script:
         - mv build/html/ public/
     artifacts:

README.md

@@ -1,5 +1,6 @@
-# cpp_sgr Usage Guide
-[![pipeline status](https://gitlab.com/mrhatch/cpp_sgr/badges/master/pipeline.svg)](https://gitlab.com/mrhatch/cpp_sgr/commits/master)
+cpp_sgr
+======
+[![pipeline status](https://gitlab.com/mrhatch/cpp_sgr/badges/master/pipeline.svg)](https://gitlab.com/mrhatch/cpp_sgr/commits/master) [Doxygen Reference](https://mrhatch.gitlab.io/cpp_sgr)
 
 cpp_sgr is a library to ease the use of SGRs in programs producing output to
 a terminal. SGRs (Select Graphic Renditions) are special character sequences
@@ -9,6 +10,10 @@ an interface that abstracts the ugly magic strings specifying SGRs behind
 convenient mnemonics, and automatically handles clearing SGRs when they
 are no longer needed.
 
+SGRs in action:
+
+![SGR Demonstration](docs/img/demo.png)
+
 ## Basics
 
 Since this library is designed with ease of use in mind, usage is simple.
@@ -137,10 +142,10 @@ std::cerr << cpp_sgr::red_bg << "Some text" << cpp_sgr::reset << "\n";
 
 ## Installation
 
-To install this library for use in a project, simply copy `include/sgr.hpp` to
-the system include directory or a project-specific include directory.
-Include `sgr.hpp` to make it available.
+To install this library for use in a project, simply copy `include/sgr.hpp` to a
+project-specific include directory, or use CMake to install the library to the
+system include directory and use find_package to import it into a CMake project.
+Include `cpp_sgr/sgr.hpp` to make it available.
 
-A demonstration program has been provided, along with a Doxygen configuration
-file. If desired, the accompanying CMake configuration file can be used
-to build the demo file and Doxygen documentation.
+A demonstration program has been provided, built as `demo`, which showcases the
+functionality of the library.

docs/Doxyfile.in

@@ -38,7 +38,7 @@ PROJECT_NAME           = "@CMAKE_PROJECT_NAME@"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@
+PROJECT_NUMBER         = @PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a