Craig Oates
4 years ago
1 changed files with 36 additions and 36 deletions
@ -1,36 +1,36 @@
|
||||
- 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.Core/blob/master/LICENSE) |
||||
|
||||
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: |
||||
|
||||
- [Console.Waterworks Wiki](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/home) |
||||
|
||||
**Console.Waterworks.Core is the .Net Core version of Console.Waterworks. Both are built the same way so, if you learn one, you learn the other.** |
||||
|
||||
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 [.Net Core 2.1](https://dotnet.microsoft.com/download/dotnet-core/2.1). |
||||
|
||||
## Notes on Writing Style |
||||
|
||||
1. I will usually refer to Console.Waterworks.Core as "C.W.C.". |
||||
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_Core_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. |
||||
|
||||
## Table of Contents |
||||
|
||||
- [Introduction to Console.Waterworks.Core](Introduction-to-Console.Waterworks.Core) |
||||
- [Overview of Console.Waterworks.Core](Overview-of-Console.Waterworks.Core) |
||||
- [Repository Breakdown](Repository-Breakdown) |
||||
- [Adding Console.Waterworks.Core to Your Project](Adding-Console.Waterworks.Core-to-Your-Project) |
||||
- [Wiring Console.Waterworks.Core into Your Project](Wiring-Console.Waterworks.Core-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.Core](Referencing-Other-Projects-in-Yours-when-Using-Console.Waterworks.Core) |
||||
- 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.Core/blob/master/LICENSE) |
||||
|
||||
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: |
||||
|
||||
- [Console.Waterworks Wiki](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/home) |
||||
|
||||
**Console.Waterworks.Core is the .Net Core version of Console.Waterworks. Both are built the same way so, if you learn one, you learn the other.** |
||||
|
||||
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 [.Net Core 2.1](https://dotnet.microsoft.com/download/dotnet-core/2.1). |
||||
|
||||
## Notes on Writing Style |
||||
|
||||
1. I will usually refer to Console.Waterworks.Core as "C.W.C.". |
||||
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_Core_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. |
||||
|
||||
## Table of Contents |
||||
|
||||
- [Introduction to Console.Waterworks.Core](Introduction-to-Console.Waterworks.Core) |
||||
- [Overview of Console.Waterworks.Core](Overview-of-Console.Waterworks.Core) |
||||
- [Repository Breakdown](Repository-Breakdown) |
||||
- [Adding Console.Waterworks.Core to Your Project](Adding-Console.Waterworks.Core-to-Your-Project) |
||||
- [Wiring Console.Waterworks.Core into Your Project](Wiring-Console.Waterworks.Core-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.Core](Referencing-Other-Projects-in-Yours-When-Using-Console.Waterworks.Core) |
||||
|
Loading…
Reference in new issue