create Repository Breakdown page.

master
Craig Oates 5 years ago
parent
commit
3ec64af9c1
  1. 1
      Home.md
  2. 11
      Repository-Breakdown.md
  3. 1
      _sidebar.md

1
Home.md

@ -29,3 +29,4 @@ Before continuing, I recommend you are familiar with the following;
## Table of Contents
- [Introduction to Smouldering Beach Ball](Introduction-to-Smouldering-Beach-Ball)
- [Repository Breakdown](Repository-Breakdown)

11
Repository-Breakdown.md

@ -0,0 +1,11 @@
The code-base in this repository is a typical Visual Studio solution. Within the solution is three projects which are;
- a .Net Standard 2.0 library (F#);
- a .Net console program (F#); and
- a .Net 4.7 library (for testing and written in F#).
The solution's main project is the .Net Standard library, called "SmoulderingBeachBall". 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 "SmoulderingBeachBallCLI" (the console program) and "TestCentre" (the testing library). To help you grasp how they all fit together, please consider the following diagrams.
IMAGE SHOWING THE PROJECTS RELATIONSHIPS.
IMAGE OF FOLDER STRUCTURE.

1
_sidebar.md

@ -4,3 +4,4 @@
- [Home](Home)
- [Introduction to Smouldering Beach Ball](Introduction-to-Smouldering-Beach-Ball)
- [Repository Breakdown](Repository-Breakdown)

Loading…
Cancel
Save