diff --git a/Home.md b/Home.md index a7c872e..40cd70c 100644 --- a/Home.md +++ b/Home.md @@ -47,6 +47,7 @@ Before continuing, I recommend you are familiar with the following; ## Table of Contents - [Introduction to Death Socket](Introduction-to-Death-Socket) +- [Repository Breakdown](Repository-Breakdown) ### As Source Code diff --git a/Repository-Breakdown.md b/Repository-Breakdown.md new file mode 100644 index 0000000..40631a1 --- /dev/null +++ b/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 as follows; + +- 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 "DeathSocket". This is where you will most likely want to start your exploration into the code-base. The other two projects are secondary but important parts of the solution. There project names are "DeathSocketCLI" (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. diff --git a/_sidebar.md b/_sidebar.md index b8d6b6f..9932698 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -4,6 +4,7 @@ - [Home](Home) - [Introduction to Death Socket](Introduction-to-Death-Socket) +- [Repository Breakdown](Repository-Breakdown) ### As Source Code