Welcome to the wiki for Console.Waterworks.Core (C.W.C.). The aim of this wiki is to teach you about **using** C.W.C. If you would like to know **how** C.W.C. was built, I recommend you read the wiki for Console.Waterworks. The wiki for that is as follows:
Before 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.
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
@ -22,8 +22,8 @@ Because this is a ported copy in a way, the wiki will focus on how to **use** Co
If you are need the traditional .Net version, or more information on how C.W.C. was built, use the following links:
@ -8,6 +8,6 @@ operates in the exact same way as the traditional .Net version.**
Because this repository focuses on teaching users how to **use** C.W.C, there is no information on how C.W.C. **works**. For that, you must refer to the wikis of the Console.Waterworks (C.W.) project. The link for that is are as follows:
If you want to add new features or fix bugs, I recommend you start with the Console.Waterworks (C.W.) 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.
@ -2,8 +2,8 @@ From a personal point-of-view, I like to keep "plumbing code" and "business logi
Because this repository does not utilise this set-up, I will provide you with a link to another project which does. It is called Wet Pancake and the links for its repository and wiki are as follows:
Within Wet Pancake is a .Net Standard Library (written in F#) and a .Net 4.7 console project (written in C#). The console project uses Console.Waterworks (C.W.) and references the F# library (yes, two different languages). I am hoping this is convincing enough for you.
@ -11,7 +11,7 @@ There are four attributes in total. They are:
For more information on the "help" attributes, please refer to the following link:
- [Help Attributes Wiki Page (main Console.Waterworks wiki)](https://gitlab.com/craig.oates/Console.Waterworks/wikis/The-%22Help%22-Attributes)
- [Help Attributes Wiki Page (main Console.Waterworks wiki)](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/The-%22Help%22-Attributes)
To set-up the "help" section , you must create a command-method first. You can use any name you want. For example, I usually call it `help`.
@ -50,4 +50,4 @@ A nice side-effect of the attributes is your command-methods are "self-documente
For the sake of completeness, I have provided a link to the `ConsoleCommands` class in CW_Core_Console. Hopefully, seeing more realistic examples will help reduce any confusion. The link is as follows:
- [Snippet's Section For Console.Waterworks.Core](https://git.abbether.net/craig.oates/Console.Waterworks.Core/snippets)
What is important to note here is the importance of the command-method names. The names you use are the exact same commands your end-user will enter at run-time. The console's input is, also, case-sensitive. This means you can have two command-methods called `Test` and `test` and have them do different things.
@ -38,6 +38,6 @@ Another feature of C.W.C. is it parses and coerces input arguments. This means y
To be clear, there are limits to the amount of types you can use with your command-methods. For a full, list of all the coercion types, please refer to the Coercion Types List in the main Console.Waterworks wiki. The link for it is as follows:
- [Coercion Types List](https://gitlab.com/craig.oates/Console.Waterworks/wikis/Coercion-Types-List) (in the main C.W. wiki)
- [Coercion Types List](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/Coercion-Types-List) (in the main C.W. wiki)
If you write command-methods with arguments **not** on the coercion list, you will get a run-time error. With that said, you are free to use whatever types you want **inside** the command-methods.
