craig.oates
/
console.waterworks
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

master
Craig Oates 4 years ago
parent
3bc724d11c
commit
5255375a65
1 changed files with 76 additions and 76 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 152
      Home.md

152
Home.md
Unescape

@ -1,76 +1,76 @@
- Created by: Craig Oates
- Web: [craigoates.net](http://www.craigoates.net)
- Email: [craig@craigoates.net](mailto:craig@craigoates.net)
- License: [MIT](https://git.abbether.net/craig.oates/Console.Waterworks/blob/master/LICENSE)
Welcome to the wiki of Console.Waterworks. The aim of this wiki is to show you how Console.Waterworks works and how it is built. Feel free to use the sidebar, on the right, to navigate around the wiki.
## Pre-Requisites
Before continuing, I recommend you are familiar with the following:
- You have experience with [C#](https://docs.microsoft.com/en-us/dotnet/csharp/).
- You can create a [.Net console program](https://docs.microsoft.com/en-us/dotnet/core/tutorials/with-visual-studio) in [Visual Studio 2017+](https://www.visualstudio.com/vs/).
- You have experience with [NuGet](https://www.nuget.org/).
- You have experience with the [.Net Framework (4.7)](https://dotnet.microsoft.com/).
## Notes
### 1. On Writing Style
1. I will usually refer to Console.Waterworks as "C.W.".
2. I will use "console program" and "console project" interchangeably. This is because of how Visual Studio's "file system" works. Overall, there is a "solution" which holds "projects". A project can consist of things like a console program. In-effect, this makes it a "program" and a "project". Hopefully, this makes sense when viewed in context.
3. The repository has a testing library called "CW-Tests". I will quite often refer to it as "test/testing library" in the wiki.
4. In an attempt to keep a level of consistency, I will abbreviate words with a full-stop. So, "HTML" will be written as "H.T.M.L.". This is because I usually abbreviate "non-tech." words this way and I am not keen on using the different styles in the same text.
### 2. About Console.Waterworks.Core
I have made a .Net Core version of Console.Waterworks. It is strictly .Net Core; So, it has no .Net Standard or traditional .Net components. If you prefer to work with that version, feel free to do so. It is call Console.Waterworks.Core (C.W.C) and the link for it is as follows:
- [Console.Waterworks.Core Repository](https://git.abbether.net/craig.oates/Console.Waterworks.Core)
Because it is port of this project, its wiki focuses on how to **use** it as a NuGet package. If you want to know how it was made, you will need to stick with this wiki. The reason why is because I want to reduce the amount of duplicated information. Both projects are built the same way. So, if you learn one, you have learned the other. The link for C.W.C's wiki is as follows:
- [Console.Waterworks.Core Wiki](https://git.abbether.net/craig.oates/Console.Waterworks.Core/wikis/home)
## Table of Contents
- [Introduction to Console.Waterworks](Introduction-to-Console.Waterworks)
- [Repository Breakdown](Repository-Breakdown)
- [Using Console.Waterworks with F#](Using-Console.Waterworks-with-F%23)
### As Source Code
- [Source Code Home](Source-Code-Home)
#### Console.Waterworks
- [Console.Waterworks Home](Console.Waterworks-Home)
- [Console.Waterworks Project Breakdown](Console.Waterwork-Project-Breakdown)
- [Console.Waterworks Flow](Console.Waterworks-Flow)
- [Coercion Types List](Coercion-Types-List)
- [The Help Attributes](The-Help-Attributes)
#### CW-Console
- [CW-Console Home](CW-Console-Home)
- [CW-Console Project Breakdown](CW-Console-Project-Breakdown)
- [CW-Console Flow](CW-Console-Flow)
- [Using CW-Console](Using-CW-Console)
#### CW-Tests
- [CW-Tests Home](CW-Tests-Home)
- [CW-Tests Project Breakdown](CW-Tests-Project-Breakdown)
- [Unit Tests Overview](Unit-Tests-Overview)
### As a NuGet
- [NuGet Home](NuGet-Home)
- [Console.Waterworks Overview](Console.Waterworks-Overview)
- [Adding Console.Waterworks to Your Project](Adding-Console.Waterworks-to-Your-Project)
- [Wiring Console.Waterworks into Your Project](Wiring-Console.Waterworks-into-Your-Project)
- [Overview of Command-Methods](Overview-of-Command-Methods)
- [Writing Command-Methods](Writing-Command-Methods)
- [Using the Help Attributes](Using-the-Help-Attributes)
- [Referencing Other Projects in Yours when Using Console.Waterworks](Referencing-Other-Projects-in-Yours-when-Using-Console.Waterworks)
- Created by: Craig Oates
- Web: [craigoates.net](http://www.craigoates.net)
- Email: [craig@craigoates.net](mailto:craig@craigoates.net)
- License: [MIT](https://git.abbether.net/craig.oates/Console.Waterworks/blob/master/LICENSE)
Welcome to the wiki of Console.Waterworks. The aim of this wiki is to show you how Console.Waterworks works and how it is built. Feel free to use the sidebar, on the right, to navigate around the wiki.
## Pre-Requisites
Before continuing, I recommend you are familiar with the following:
- You have experience with [C#](https://docs.microsoft.com/en-us/dotnet/csharp/).
- You can create a [.Net console program](https://docs.microsoft.com/en-us/dotnet/core/tutorials/with-visual-studio) in [Visual Studio 2017+](https://www.visualstudio.com/vs/).
- You have experience with [NuGet](https://www.nuget.org/).
- You have experience with the [.Net Framework (4.7)](https://dotnet.microsoft.com/).
## Notes
### 1. On Writing Style
1. I will usually refer to Console.Waterworks as "C.W.".
2. I will use "console program" and "console project" interchangeably. This is because of how Visual Studio's "file system" works. Overall, there is a "solution" which holds "projects". A project can consist of things like a console program. In-effect, this makes it a "program" and a "project". Hopefully, this makes sense when viewed in context.
3. The repository has a testing library called "CW-Tests". I will quite often refer to it as "test/testing library" in the wiki.
4. In an attempt to keep a level of consistency, I will abbreviate words with a full-stop. So, "HTML" will be written as "H.T.M.L.". This is because I usually abbreviate "non-tech." words this way and I am not keen on using the different styles in the same text.
### 2. About Console.Waterworks.Core
I have made a .Net Core version of Console.Waterworks. It is strictly .Net Core; So, it has no .Net Standard or traditional .Net components. If you prefer to work with that version, feel free to do so. It is call Console.Waterworks.Core (C.W.C) and the link for it is as follows:
- [Console.Waterworks.Core Repository](https://git.abbether.net/craig.oates/Console.Waterworks.Core)
Because it is port of this project, its wiki focuses on how to **use** it as a NuGet package. If you want to know how it was made, you will need to stick with this wiki. The reason why is because I want to reduce the amount of duplicated information. Both projects are built the same way. So, if you learn one, you have learned the other. The link for C.W.C's wiki is as follows:
- [Console.Waterworks.Core Wiki](https://git.abbether.net/craig.oates/Console.Waterworks.Core/wikis/home)
## Table of Contents
- [Introduction to Console.Waterworks](Introduction-to-Console.Waterworks)
- [Repository Breakdown](Repository-Breakdown)
- [Using Console.Waterworks with F#](Using-Console.Waterworks-with-F%23)
### As Source Code
- [Source Code Home](Source-Code-Home)
#### Console.Waterworks
- [Console.Waterworks Home](Console.Waterworks-Home)
- [Console.Waterworks Project Breakdown](Console.Waterworks-Project-Breakdown)
- [Console.Waterworks Flow](Console.Waterworks-Flow)
- [Coercion Types List](Coercion-Types-List)
- [The Help Attributes](The-Help-Attributes)
#### CW-Console
- [CW-Console Home](CW-Console-Home)
- [CW-Console Project Breakdown](CW-Console-Project-Breakdown)
- [CW-Console Flow](CW-Console-Flow)
- [Using CW-Console](Using-CW-Console)
#### CW-Tests
- [CW-Tests Home](CW-Tests-Home)
- [CW-Tests Project Breakdown](CW-Tests-Project-Breakdown)
- [Unit Tests Overview](Unit-Tests-Overview)
### As a NuGet
- [NuGet Home](NuGet-Home)
- [Console.Waterworks Overview](Console.Waterworks-Overview)
- [Adding Console.Waterworks to Your Project](Adding-Console.Waterworks-to-Your-Project)
- [Wiring Console.Waterworks into Your Project](Wiring-Console.Waterworks-into-Your-Project)
- [Overview of Command-Methods](Overview-of-Command-Methods)
- [Writing Command-Methods](Writing-Command-Methods)
- [Using the Help Attributes](Using-the-Help-Attributes)
- [Referencing Other Projects in Yours when Using Console.Waterworks](Referencing-Other-Projects-in-Yours-when-Using-Console.Waterworks)

Write Preview
Loading…
Cancel
Save