From 9833ea5ecf449f45762f54bdb12d94ef4075eac1 Mon Sep 17 00:00:00 2001 From: Craig Oates Date: Mon, 23 Oct 2017 22:09:45 +0100 Subject: [PATCH] Added table of contents. --- Home.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 4831fb9..2203a60 100644 --- a/Home.md +++ b/Home.md @@ -1,7 +1,44 @@ ![CW_Header](https://github.com/CraigOates/Console.Waterworks/blob/develop/Documentation/GitHub_Assets/CW_Header.png) -- Created by Craig Oates +- Created by [Craig Oates](https://github.com/CraigOates) - Web: [craigoates.net](http://www.craigoates.net, "Craig's website") - Email: craig@craigoates.net - Project's Site: [http://craigsappshed.azurewebsites.net/Waterworks](http://craigsappshed.azurewebsites.net/Waterworks, "CW's home site") - License: [MIT](https://github.com/CraigOates/Console.Waterworks/blob/master/LICENSE, "CW's License") + +--- + +## Table of Contents + +- [Home](https://github.com/CraigOates/Console.Waterworks/wiki) +- [Preface](https://github.com/CraigOates/Console.Waterworks/wiki/Preface) +- [Introduction](https://github.com/CraigOates/Console.Waterworks/wiki/Introduction) + +## As a Nuget Package + +### Setting Up + +- [Adding Console.Waterworks to Your Project](https://github.com/CraigOates/Console.Waterworks/wiki/Adding-Console.Waterworks-to-Your-Project) +- [Wire Console.Waterworks into Your Program](https://github.com/CraigOates/Console.Waterworks/wiki/Wire-C.W.-into-Your-Program) +- [Writing Command-Methods](https://github.com/CraigOates/Console.Waterworks/wiki/Writing-Command-Methods) + +### Creating a "Help Section" + +- [Setting up the "Help Section"](https://github.com/CraigOates/Console.Waterworks/wiki/Setting-up-the-%22Help-Section%22) +- [The "Help" Attributes](https://github.com/CraigOates/Console.Waterworks/wiki/The-%22Help%22-Attributes) +- [Using the "Help" Attributes](https://github.com/CraigOates/Console.Waterworks/wiki/Using-the-%22Help-Attributes%22) + +### Useful References + +- [Console.Waterworks Code Example (in Full)](https://github.com/CraigOates/Console.Waterworks/wiki/Console.Waterworks-Code-Example-(in-Full)) +- [Things to Consider for Run-time](https://github.com/CraigOates/Console.Waterworks/wiki/Things-to-Consider-for-Run-time) +- [Example Projects](https://github.com/CraigOates/Console.Waterworks/wiki/Example-Projects) + +## Architecture + +- [Architecture Overview](https://github.com/CraigOates/Console.Waterworks/wiki/Architecture-Overview) +- [Department Breakdown: Teams](https://github.com/CraigOates/Console.Waterworks/wiki/Department-Breakdown:-Teams) +- [Coercion Types List](https://github.com/CraigOates/Console.Waterworks/wiki/Coercion-Types-List) +- [The Flow of the System](https://github.com/CraigOates/Console.Waterworks/wiki/The-Flow-of-the-System) +- [The Missing Piece: ConsoleCommands.cs](https://github.com/CraigOates/Console.Waterworks/wiki/The-Missing-Piece:-ConsoleCommands.cs) +- [Recommendations for Altering Console.Waterworks](https://github.com/CraigOates/Console.Waterworks/wiki/Recommendations-for-Those-Wanting-to-Alter-Console.Waterworks)