5 Repository Breakdown
Craig Oates edited this page 4 years ago

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 diagram:

folder structure

The console program provides a way for people to use the features in DeathSocket without them needing to write code. The testing library is as the name implies: the place where the unit and property tests for the .Net Standard library and the console program reside. To see how each project is referenced, please view the following diagram:

project references

  • DeathSocket is referenced in DeathSocketCLI and TestCentre.
  • DeathSocketCLI is referenced in TestCentre.
  • TestCentre is not referenced in anything.