diff --git a/Referencing-Other-Projects-in-Yours-When-Using-Console.Waterworks.Core.md b/Referencing-Other-Projects-in-Yours-When-Using-Console.Waterworks.Core.md new file mode 100644 index 0000000..e386f03 --- /dev/null +++ b/Referencing-Other-Projects-in-Yours-When-Using-Console.Waterworks.Core.md @@ -0,0 +1,24 @@ +From a personal point-of-view, I like to keep "plumbing code" and "business logic" separate. The most common approach I take to do this is create various library projects and reference them in the main project. This all happens in the same solution if I can help it. Because of this preference, I designed Console.Waterworks.Core (C.W.C.) to operate with this as the default context. + +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: + +- [Wet Pancake Repository](https://gitlab.com/craig.oates/Wet-Pancake) +- [Wet Pancake Wiki](https://gitlab.com/craig.oates/Wet-Pancake/wikis/home) + +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. + +For the sake of completeness, here is a quick overview of Wet Pancakes' set-up. + +![wet pancake overview](attachments/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. + +![library referencing example](attachments/library-referencing-example.png) + +![multi-library referencing example](attachments/multi-library-ref-example.png) + +An important note to make is your must call the code from another library **inside** the command-methods. + +If you are unsure how to reference a .Net library in another project, within your solution, use the following link for more information: + +- [Manage References in a Project](https://docs.microsoft.com/en-us/visualstudio/ide/managing-references-in-a-project?view=vs-2019) diff --git a/Using-the-Help-Attributes.md b/Using-the-Help-Attributes.md index b5b7185..54bbf7a 100644 --- a/Using-the-Help-Attributes.md +++ b/Using-the-Help-Attributes.md @@ -21,7 +21,7 @@ Within the "help" command-method, enter the following code: public static string help() { CW_Liaison liaison = new CW_Liaison(); - // Don't forget your name-space for your ConsoleCommands class + // Don't forget your name-space for your ConsoleCommands class return liaison.RequestHelpDocumentation("YOUR NAME-SPACE HERE"); } ```