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.
Before continuing, I recommend you are familiar with the following:
- You have experience with C#.
- You can create a .Net console program in Visual Studio 2017+.
- You have experience with NuGet.
- You have experience with the .Net Framework (4.7).
1. On Writing Style
- I will usually refer to Console.Waterworks as "C.W.".
- 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.
- The repository has a testing library called "CW-Tests". I will quite often refer to it as "test/testing library" in the wiki.
- 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:
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:
Table of Contents
As Source Code
- Console.Waterworks Home
- Console.Waterworks Project Breakdown
- Console.Waterworks Flow
- Coercion Types List
- The Help Attributes