Craig Oates
5 years ago
4 changed files with 23 additions and 0 deletions
@ -0,0 +1,13 @@
|
||||
The code-base in this repository is a typical Visual Studio solution. Within the solution is three projects which are: |
||||
|
||||
- a .Net 4.7 library (F#); |
||||
- a .Net console program (C#); and |
||||
- a .Net 4.7 library (for testing and written in F#). |
||||
|
||||
The solution's main project is the .Net 4.7 library, called "WetPancake". This is where you will most likely want to start your exploration into the code. The other two projects are secondary but important parts of the solution. There project names are "WetPancakeCLI" (the console program) and "TestCentre" (the testing library). To help you grasp how they all fit together, please consider the images below. |
||||
|
||||
![solution overview](attachments/solution-overview.png) |
||||
|
||||
The image below shows how each project is referenced within the solution. WetPancake and WetPancakeCLI are referenced in TestCentre; And, WetPancake is referenced in WetPancakeCLI. This leaves WetPancake referencing none of the other two. |
||||
|
||||
![wet pancake projects ref's](attachments/wp-proj-refs.png) |
@ -0,0 +1,8 @@
|
||||
This section is for those wanting to work with the repositories source code. If you are more interested in using Wet Pancake's features via NuGet package or the C.L.I., use the following links: |
||||
|
||||
- ["As a Command Line Interface (C.L.I.)" section](CLI-Home) (if you want to use the console program which comes with this repository) |
||||
- [“As a NuGet” section](NuGet-Home) (if you want to add WetPancake to your project) |
||||
|
||||
## Table of Contents |
||||
|
||||
TODO: Write when everything is written up. |
Loading…
Reference in new issue