move and update images and their links.

master
Craig Oates 4 years ago
parent
commit
a28d98032c
  1. 2
      Adding-Console.Waterworks.Core-to-Your-Project.md
  2. 1
      Home.md
  3. 2
      Overview-of-Command-Methods.md
  4. 2
      Overview-of-Console.Waterworks.Core.md
  5. 6
      Referencing-Other-Projects-in-Yours-When-Using-Console.Waterworks.Core.md
  6. 4
      Repository-Breakdown.md
  7. 2
      Using-the-Help-Attributes.md
  8. 6
      Wiring-Console.Waterworks.Core-into-Your-Project.md
  9. 6
      Writing-Command-Methods.md
  10. 2
      _Sidebar.md
  11. 0
      assembly-info-screenshot.png
  12. 0
      command-methods-overview.png
  13. 0
      console-library-relationship.png
  14. 0
      console.waterworks-data-flow.png
  15. 0
      consolecommands-library-binding.png
  16. 0
      invalid-arguments-input.gif
  17. 0
      invalid-command-input.gif
  18. 0
      method-mapping.gif
  19. 0
      no-assembly-info-screenshot.png
  20. 0
      nuget-package-manager-screenshot.png
  21. 0
      project-references.png
  22. 0
      run-time-help.gif
  23. 0
      sidebar-banner.png
  24. 0
      solution-overview.png
  25. 0
      wetpancake-overview.png

2
Adding-Console.Waterworks.Core-to-Your-Project.md

@ -13,7 +13,7 @@ dotnet add package Console.Waterworks.Core --version 1.0.0.1
If you are using the NuGet Package Manager in Visual Studio, you can search for C.W.C. and install it from there. If you do that, your Visual Studio should look similar to the image below.
![nuget package manager gui](attachments/nuget-package-manager-screenshot.png)
![nuget package manager gui](nuget-package-manager-screenshot.png)
You can find more information about C.W.C. on NuGet's website. If you would like to do that, use the following links:

1
Home.md

@ -34,4 +34,3 @@ Before continuing, I recommend you are familiar with the following:
- [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)
- [Code Snippets for Common Tasks](https://git.abbether.net/craig.oates/Console.Waterworks.Core/snippets)

2
Overview-of-Command-Methods.md

@ -2,4 +2,4 @@ There is nothing special about command-methods. They are nothing more than the m
Here is a diagram to help show the "position" of the command-methods within the project.
![command-methods overview](attachments/command-methods-overview.png)
![command-methods overview](command-methods-overview.png)

2
Overview-of-Console.Waterworks.Core.md

@ -3,7 +3,7 @@ Console.Waterworks.Core (C.W.C.) is a NuGet package. I wrote it in C# with the i
**Console.Waterworks.Core (C.W.C.) is the .Net Core version. It
operates in the exact same way as the traditional .Net version.**
![Console.Waterworks.Core Data-Flow](attachments/console.waterworks-data-flow.png)
![Console.Waterworks.Core Data-Flow](console.waterworks-data-flow.png)
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:

6
Referencing-Other-Projects-in-Yours-When-Using-Console.Waterworks.Core.md

@ -9,13 +9,13 @@ Within Wet Pancake is a .Net Standard Library (written in F#) and a .Net 4.7 con
For the sake of completeness, here is a quick overview of Wet Pancakes' set-up.
![wet pancake overview](attachments/wetpancake-overview.png)
![wet pancake overview](wetpancake-overview.png)
In more generic terms, here are a couple of diagrams to help explain where/how C.W.C. slots into your project.
![multi-library referencing example](attachments/consolecommands-library-binding.png)
![multi-library referencing example](consolecommands-library-binding.png)
![library referencing example](attachments/console-library-relationship.png)
![library referencing example](console-library-relationship.png)
An important note to make is your must call the code from another library **inside** the command-methods.

4
Repository-Breakdown.md

@ -8,8 +8,8 @@ All three projects are written in C#.
The solution's main project is the .Net Core 2.1 library, called Console.Waterworks.Core. This is where you will most likely want to start your exploration of the code-base. The other two are secondary but important parts of the solution. Their names are CW_Core_Console and CW_Tests. To help you grasp what that looks like, please consider the following image.
![solution overview](attachments/solution-overview.png)
![solution overview](solution-overview.png)
The image below shows how each project is referenced within the solution. Console.Waterworks.Core and CW_Core_Console are referenced in CW_Tests; And, Console.Waterworks.Core is referenced in CW_Core_Console. This leaves Console.Waterworks.Core referencing none of the other two.
![project references](attachments/project-references.png)
![project references](project-references.png)

2
Using-the-Help-Attributes.md

@ -1,6 +1,6 @@
To help users discover features within your console program, Console.Waterworks.Core (C.W.C.) provides a run-time "help" section. It does this by using the (C#/.Net) attributes you attach to your command-methods. It is, also, optional. So, you do not need to decorate your command-methods if you do not want to. If you have cloned this repository, you can see this in action. To do so, run console program and enter "Help" into the prompt. You should see a list of available commands, a description of what they do and how to use them.
![screenshot of help at run-time](attachments/run-time-help.gif)
![screenshot of help at run-time](run-time-help.gif)
There are four attributes in total. They are:

6
Wiring-Console.Waterworks.Core-into-Your-Project.md

@ -69,17 +69,17 @@ namespace CW_Core_Console // This will be different to yours.
If all has gone well, your program should run (press F5) and when you enter "Test" into the console, you should see something similar to the image below.
![successful c.w.c. set-up screenshot](attachments/method-mapping.gif)
![successful c.w.c. set-up screenshot](method-mapping.gif)
Within the `Main` function is a method called `Run`, which takes two arguments. The first is the name-space of the `ConsoleCommands` class and the second one is a `bool`. In the example above, I have used `true` but I could have used `false` if I wanted. The reason I used `true` is because I prefer my console programs to display its assembly information when I run it. If you prefer just the prompt, change the `true` variable to `false`. If all has gone well, you should see something similar to the screenshots below.
**Console program, displaying its assembly information.**
![assembly info screenshot](attachments/assembly-info-screenshot.png)
![assembly info screenshot](assembly-info-screenshot.png)
**Console program, displaying just the prompt.**
![no assembly info screenshot](attachments/no-assembly-info-screenshot.png)
![no assembly info screenshot](no-assembly-info-screenshot.png)
I will not go into too much detail about changing a project's assembly information because there is already an amble amount of information on the subject. Instead, I will provide the following links to get to started:

6
Writing-Command-Methods.md

@ -28,13 +28,13 @@ More examples can be found at the following links:
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.
![screenshot of command-method and console commands](attachments/method-mapping.gif)
![screenshot of command-method and console commands](method-mapping.gif)
Another feature of C.W.C. is it parses and coerces input arguments. This means your command-methods can include arguments and C.W.C. takes care of the error-handling and messaging for you.
![screenshot of error-handling 1](attachments/invalid-command-input.gif)
![screenshot of error-handling 1](invalid-command-input.gif)
![screenshot of error-handling 2](attachments/invalid-arguments-input.gif)
![screenshot of error-handling 2](invalid-arguments-input.gif)
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:

2
_Sidebar.md

@ -1,4 +1,4 @@
![sidebar banner](attachments/sidebar-banner.png)
![sidebar banner](sidebar-banner.png)
## Table of Contents

0
attachments/assembly-info-screenshot.png → assembly-info-screenshot.png

Before

Width:  |  Height:  |  Size: 230 KiB

After

Width:  |  Height:  |  Size: 230 KiB

0
attachments/command-methods-overview.png → command-methods-overview.png

Before

Width:  |  Height:  |  Size: 100 KiB

After

Width:  |  Height:  |  Size: 100 KiB

0
attachments/console-library-relationship.png → console-library-relationship.png

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 81 KiB

0
attachments/console.waterworks-data-flow.png → console.waterworks-data-flow.png

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

0
attachments/consolecommands-library-binding.png → consolecommands-library-binding.png

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 76 KiB

0
attachments/invalid-arguments-input.gif → invalid-arguments-input.gif

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

0
attachments/invalid-command-input.gif → invalid-command-input.gif

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

0
attachments/method-mapping.gif → method-mapping.gif

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

0
attachments/no-assembly-info-screenshot.png → no-assembly-info-screenshot.png

Before

Width:  |  Height:  |  Size: 197 KiB

After

Width:  |  Height:  |  Size: 197 KiB

0
attachments/nuget-package-manager-screenshot.png → nuget-package-manager-screenshot.png

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 84 KiB

0
attachments/project-references.png → project-references.png

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

0
attachments/run-time-help.gif → run-time-help.gif

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 112 KiB

0
attachments/sidebar-banner.png → sidebar-banner.png

Before

Width:  |  Height:  |  Size: 3.7 KiB

After

Width:  |  Height:  |  Size: 3.7 KiB

0
attachments/solution-overview.png → solution-overview.png

Before

Width:  |  Height:  |  Size: 264 KiB

After

Width:  |  Height:  |  Size: 264 KiB

0
attachments/wetpancake-overview.png → wetpancake-overview.png

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

Loading…
Cancel
Save