xBefore digging too far into the project, it is a good idea to know why it exists. On top of that, you should, also, know about its limitation. Without either of these two pieces of information, you will likely find frustration; Which is no use to anyone.
Why This Repository (and Wiki) Exists
I stumbled upon a project called ConsoleApplicationBase by TypeCast Exception. I liked it and it solved a problem I had at the time. After a while, I became frustrated with the set-up time needed with each new project. (This was more so with small/throwaway projects.) When my level of frustration crossed the tipping point, I decided to take the ConsoleApplicationBase template and package it up into NuGet. The aim was to create something which mimics what ConsoleApplicationBase does but with less set-up/ceremony. Console.Waterworks (not Core) was the result.
When I began creating Console.Waterworks, the traditional .Net Framework and .Net Core where two very separate entities -- more so than now. This meant Console.Waterworks only worked with the traditional .Net 4.7 Framework. Because of this limitation, I needed to create a .Net Core version thus Console.Waterworks.Core.
Console.Waterworks.Core is the .Net Core equivalent of Console.Waterworks which is the traditional .Net (4.7) Framework version.
You can find out more about TypeCast Exception's project by using the following links:
- TypeCast Exception's GitHub Profile
- ConsoleApplicationBase Reposoitory
- TypeCast Exception's Blog Post on ConsoleApplicationBase
Limitations of This Repository
The repository is strictly a .Net Core one. Every project within the (Visual Studio) solution is a .Net Core one and they do/will not mix with the traditional .Net Framework. If you want to play with the source code in this repository you need to have the .Net Core tools and run-time on your machine. Using a Windows system is not enough.
Because this is a ported copy in a way, the wiki will focus on how to use Console.Waterworks.Core (C.W.C.). It will not go into how it was made. This is to reduce the amount of duplicated information. If you know how one system works, you know how both of them work. That is why I have made the Console.Waterworks (C.W.) wiki the main one. Within it, you will find information on how the system was built and how to modify the code base. It, also, provides rundowns of the console project and the testing library which comes with each repository. In some ways, this wiki is like the quick-guide version and C.W's one is the complete version.
If you are need the traditional .Net version, or more information on how C.W.C. was built, use the following links:
- Console.Waterworks Repository
- Console.Waterworks Wiki
- Console.Waterworks NuGet Profile
- Console.Waterworks.Core NuGet Profile
The Reason for no Visual Basic Repository
The simple answer is I do not know Visual Basic. If you do know Visual Basic and would like to provide something like this repository, feel free to do so.
Table of Contents
- Home
- Introduction to Console.Waterworks.Core
- Overview of Console.Waterworks.Core
- Repository Breakdown
- Adding Console.Waterworks.Core to Your Project
- Wiring Console.Waterworks.Core into Your Project
- Overview of Command-Methods
- Writing Command-Methods
- Using the Help Attributes
- Referencing Other Projects in Yours when Using Console.Waterworks.Core