From 01750a0a441065a90629ad897c02ab1a04c35ab9 Mon Sep 17 00:00:00 2001 From: Craig Date: Wed, 24 Jul 2019 16:27:57 +0100 Subject: [PATCH] create Repo. Breakdown. --- Overview-of-Console.Waterworks.Core.md | 2 +- Repository-Breakdown.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 Repository-Breakdown.md diff --git a/Overview-of-Console.Waterworks.Core.md b/Overview-of-Console.Waterworks.Core.md index d5b2d1a..1513e59 100644 --- a/Overview-of-Console.Waterworks.Core.md +++ b/Overview-of-Console.Waterworks.Core.md @@ -7,7 +7,7 @@ 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: -* [Console.Waterworks +- [Console.Waterworks Wiki](https://gitlab.com/craig.oates/Console.Waterworks/wikis/home) 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. diff --git a/Repository-Breakdown.md b/Repository-Breakdown.md new file mode 100644 index 0000000..85319f2 --- /dev/null +++ b/Repository-Breakdown.md @@ -0,0 +1,15 @@ +The code-base in this repository is a typical Visual Studio solution. Within the solution is three projects. They are: + +- a .Net Core 2.1 library +- a .Net Core console program +- a .Net Core 2.1 "testing" library + +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. + +![repo. breakdown](attachments/repository-breakdown.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)