Merge pull request #10 from dglmoore/docs

Create documentation

.gitignore

@@ -34,3 +34,4 @@
 
 # Build Directories
 build
+docs/*.html

CMakeLists.txt

@@ -39,3 +39,8 @@ install(DIRECTORY include/ DESTINATION include)
 
 enable_testing()
 add_subdirectory(test)
+
+if (EXAMPLES)
+    message(STATUS "Building Examples")
+    add_subdirectory(examples)
+endif()

README.adoc

@@ -0,0 +1,57 @@
+= Ginger: A simple library for a more fruitful C
+Douglas G. Moore <doug@dglmoore.com>
+v0.2.0, October 2017
+:source-highlighter: prettify
+:stem: latexmath
+
+*Ginger* is a simple library written to make C programmers' lives easier by
+augmenting the C standard library with useful utilities that are sorely lacking.
+
+image:https://travis-ci.org/dglmoore/ginger.svg?branch=master[Build Status (Travis CI), link=https://travis-ci.org/dglmoore/ginger]
+image:https://ci.appveyor.com/api/projects/status/c7jo983wjih5hahb?svg=true[Build Status (AppVeyor), link=https://ci.appveyor.com/project/dglmoore/ginger]
+
+== Installation
+To build *ginger*, you will need to have https://cmake.org/[CMake]. For most
+you can use your package manager, e.g. `apt-get`, `pacman` or `yum` on Linux
+or `homebrew`, `macports` or `fink` on OS X.
+
+=== Linux, OS X, and Windows (Bash, MinGW and Cygwin)
+Once CMake is installed, building, testing and installing the library is a snap
+[source,sh]
+----
+λ cmake . -DCMAKE_BUILD_TYPE=Release
+λ make all tests
+λ sudo make install
+----
+
+=== Windows with MSVC
+Building with MSVC is a bit more involved. Open the Visual C++ MSBuild command
+prompt (should be in your start menu). You can then run cmake build and test
+from the prompt:
+[source,sh]
+----
+λ cmake -DCMAKE_BUILD_TYPE=Release -G"Visual Studio 14 2015"
+λ msbuild /p:Configuration=Release ALL_BUILD.vcxproj
+λ test\Release\ginger_unittest.exe
+----
+Installation requires the user to manually copy the headers and libraries to
+wherever the user would like.
+
+== Getting Help
+*Ginger* is developed to help you write better C code faster, but I can't do it
+without your feedback. I host the project's source code and issue tracker on
+GitHub. Please create an issue if you find a bug, an error in this
+documentation, or have a feature you'd like to request.
+
+Ginger Source Repository::
+    https://github.com/dglmoore/ginger
+
+Issue tracker::
+    https://github.com/dglmoore/ginger/issues
+
+== Copyright and Licensing
+Copyright © 2016-2017 Douglas G. Moore. Free use of this software is granted
+under the terms of the MIT License.
+
+See the https://github.com/dglmoore/ginger/blob/master/LICENSE[LICENSE] file for
+details.

docs/Makefile

@@ -0,0 +1,9 @@
+all: index.html
+
+%.html: %.adoc
+	asciidoctor -b html5 $<
+
+clean:
+	rm -rf *.html
+
+.PHONY: clean

docs/getting-started.adoc

@@ -0,0 +1,47 @@
+= Getting Started
+
+== Installation
+To build *ginger*, you will need to have https://cmake.org/[CMake]. For most
+you can use your package manager, e.g. `apt-get`, `pacman` or `yum` on Linux
+or `homebrew`, `macports` or `fink` on OS X.
+
+=== Linux, OS X, and Windows (Bash, MinGW and Cygwin)
+Once CMake is installed, building, testing and installing the library is a snap
+[source, sh]
+----
+λ cmake . -DCMAKE_BUILD_TYPE=Release
+λ make all tests
+λ sudo make install
+----
+
+=== Windows with MSVC
+Building with MSVC is a bit more involved. Open the Visual C++ MSBuild command
+prompt (should be in your start menu). You can then run cmake build and test
+from the prompt:
+[source, sh]
+----
+λ cmake -DCMAKE_BUILD_TYPE=Release -G"Visual Studio 14 2015"
+λ msbuild /p:Configuration=Release ALL_BUILD.vcxproj
+λ test\Release\ginger_unittest.exe
+----
+Installation requires the user to manually copy the headers and libraries to
+wherever the user would like.
+
+== Getting Help
+*Ginger* is developed to help you write better C code faster, but I can't do it
+without your feedback. I host the project's source code and issue tracker on
+GitHub. Please create an issue if you find a bug, an error in this
+documentation, or have a feature you'd like to request.
+
+Ginger Source Repository::
+    https://github.com/dglmoore/ginger
+
+Issue tracker::
+    https://github.com/dglmoore/ginger/issues
+
+== Copyright and Licensing
+Copyright © 2016-2017 Douglas G. Moore. Free use of this software is granted
+under the terms of the MIT License.
+
+See the https://github.com/dglmoore/ginger/blob/master/LICENSE[LICENSE] file for
+details.

docs/index.adoc

@@ -0,0 +1,21 @@
+= Ginger: A simple library for a more fruitful C
+Douglas G. Moore <doug@dglmoore.com>
+v0.2.0, October 2017
+:toc2:
+:toclevels: 3
+:source-highlighter: prettify
+:stem: latexmath
+
+*Ginger* is a simple library written to make C programmers' lives easier by
+augmenting the C standard library with useful utilities that are sorely lacking.
+
+image:https://travis-ci.org/dglmoore/ginger.svg?branch=master[Build Status (Travis CI), link=https://travis-ci.org/dglmoore/ginger]
+image:https://ci.appveyor.com/api/projects/status/c7jo983wjih5hahb?svg=true[Build Status (AppVeyor), link=https://ci.appveyor.com/project/dglmoore/ginger]
+
+:leveloffset: 1
+
+include::getting-started.adoc[]
+
+include::vector.adoc[]
+
+include::unit.adoc[]