Updating documentation

doc/Doxyfile

@@ -37,7 +37,7 @@ PROJECT_NUMBER         = 1.0
 # for a project that appears at the top of each page and should give viewer
 # a quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Cross-platform serial port library for C++"
+PROJECT_BRIEF          = "Cross-platform serial port library written in C++"
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is
 # included in the documentation. The maximum height of the logo should not
@@ -610,7 +610,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = include src
+INPUT                  = doc/serial.dox include src examples
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

doc/serial.dox

@@ -0,0 +1,64 @@
+/*!
+\mainpage Serial Library
+
+\author William Woodall <wjwwood@gmail.com>, John Harrison <ash@greaterthaninfinity.com>
+
+\section what_is What is serial?
+Serial is a cross-platform, simple to use library for using serial ports on computers.  This library provides a C++, object oriented interface for interacting with RS-232 like devices on Linux and Windows.
+
+Want to use it with ROS(Robot Operating System)? No problem, it compiles as a unary stack.
+
+\section getting_started Getting Started
+
+Ready to jump in?
+- Checkout our examples: \ref serial_example.cc
+- Look at the main class documentation: \ref serial::Serial
+
+\section features Features
+- Linux, Mac OS X, and Windows Support
+- Easy to use interface (modeled after PySerial)
+- Minimal dependencies (cmake)
+- Complete timeout control \ref serial::Serial::setTimeout
+- Check and set handshaking lines (CTS, DSR, RI, CD and RTS, DTR)
+- Block for changes in handshaking lines (Linux and Windows)
+- Flush I/O separately and block until all writing done
+
+\section install Installation
+
+\subsection Dependencies
+
+- CMake:
+ - CMake is required for building the system and can be located here: http://www.cmake.org/
+
+\subsection building Compiling
+
+Once you have gathered the dependencies, you need to checkout the software from github.com: 
+
+<pre>
+    git clone git://github.com/wjwwood/serial.git
+</pre>
+
+Once you have checked out the source code from github.com you can enter the directory and build the software.
+
+<pre>
+    cd serial
+    make
+    make test # (optional) builds the example and tests, and runs the tests.
+    make doc  # (optional) builds _this_ documentation.
+</pre>
+
+\subsection installing Installing
+
+To install simply:
+
+<pre>
+    sudo make install
+</pre>
+
+To uninstall simply:
+
+<pre>
+    sudo make uninstall
+</pre>
+
+ */

serial.sublime-project

@@ -4,7 +4,7 @@
 	"folders":
 	[
 		{
-			"path": "/Users/william/devel/serial"
+			"path": "./"
 		}
 	],
 	"settings":
@@ -13,7 +13,6 @@
 		[
 			"-I/usr/include",
 			"-I/usr/local/include",
-			// "-I/usr/lib/clang/3.1/include/",
 			"-I${folder:${project_path:serial.sublime-project}}/include"
 		]
 	}