diff --git a/Home.md b/Home.md index 1504f93..0fc496c 100644 --- a/Home.md +++ b/Home.md @@ -23,6 +23,6 @@ Before continuing, I recommend you are familiar with the following; ## Table of Contents -* [Code Snippets for Common Tasks](https://gitlab.com/craig.oates/Brittle-Fish/snippets) -* [Introduction to Brittle Fish](Introduction-to-Brittle-Fish) +1. [Introduction to Brittle Fish](Introduction-to-Brittle-Fish) +1. [Code Snippets for Common Tasks](https://gitlab.com/craig.oates/Brittle-Fish/snippets) diff --git a/Overview-of-Console.Waterwork.md b/Overview-of-Console.Waterwork.md deleted file mode 100644 index e69de29..0000000 diff --git a/Overview-of-Console.Waterworks.md b/Overview-of-Console.Waterworks.md new file mode 100644 index 0000000..7b88685 --- /dev/null +++ b/Overview-of-Console.Waterworks.md @@ -0,0 +1,12 @@ +Console.Waterworks (C.W.) is a NuGet package. I wrote in C# for use in console programs. The main feature it provides is a way to make command-based (MVC?) console programs. It does this this by parsing input from the end-user and mapping it to a particular "command-method". C.W., also, does error-handling. This allows you to focus on writing your "business logic". Another way to look at it is C.W. provides the "plumbing code". + +**Console.Waterworks.Core (C.W.C.) is the .Net Core version. It operates in the exact same way as the tradition .Net version.** + +IMAGE OF C.W FLOW OF DATA. + +Because this repository focuses on teaching users how to **use** C.W. with F#, there is no information on they **work**. For that, you must refer to the wikis of the actual projects. Their links are as follows; + +* [Console.Waterworks Wiki](https://gitlab.com/craig.oates/Console.Waterworks/wikis/home) -- for using with C# and altering the source code. +* [Console.Waterworks.Core Wiki](https://gitlab.com/craig.oates/Console.Waterworks.Core/wikis/home) -- for using C.W.C. with C#. + +If you want to add new features or fix bugs, I recommend you start with the Console.Waterworks wiki. This is because the "Core" version's wiki focuses on **using** C.W.C. The C.W. wiki explains the architecture **and** how to use it. If you are wondering why the "Core" version omits the architecture part, it is to avoid duplication. Both versions use the same architecture. So, if you know one, you know both. The only difference between them is one targets the traditional .Net frame and the other does not. diff --git a/_sidebar.md b/_sidebar.md index 9610dce..c40c7f4 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -3,5 +3,5 @@ ## Table of Contents 1. [Home](Home) -2. [Code Snippets for Common Tasks](https://gitlab.com/craig.oates/Brittle-Fish/snippets) -3. [Introduction to Brittle Fish](Introduction-to-Brittle-Fish) +1. [Introduction to Brittle Fish](Introduction-to-Brittle-Fish) +1. [Code Snippets for Common Tasks](https://gitlab.com/craig.oates/Brittle-Fish/snippets)