From 9238191a563a62bfd0586fff96e60b7159d5f84e Mon Sep 17 00:00:00 2001 From: Craig Date: Fri, 28 Jun 2019 20:46:34 +0100 Subject: [PATCH] create D.S. Project Breakdown page. --- DeathSocket-Home.md | 1 + DeathSocket-Project-Breakdown.md | 7 +++++++ Home.md | 1 + Source-Code-Home.md | 1 + _sidebar.md | 1 + 5 files changed, 11 insertions(+) create mode 100644 DeathSocket-Project-Breakdown.md diff --git a/DeathSocket-Home.md b/DeathSocket-Home.md index 83801ec..45732c0 100644 --- a/DeathSocket-Home.md +++ b/DeathSocket-Home.md @@ -5,5 +5,6 @@ This section focuses on the source code within the project called "DeathSocket". ## Table of Contents +- [DeathSocket Project Breakdown](DeathSocket-Project-Breakdown) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) diff --git a/DeathSocket-Project-Breakdown.md b/DeathSocket-Project-Breakdown.md new file mode 100644 index 0000000..58e6878 --- /dev/null +++ b/DeathSocket-Project-Breakdown.md @@ -0,0 +1,7 @@ +This section focuses on the source code within the "DeathSocket" project. It is the main project within the solution/repository. + +PROJECT FILE LAYOUT IMAGE. + +This project is a .Net Standard 2.0 library, written in F#. Within the project you will see eight files, including "DeathSocket.fsproj". This "fsproj" file is a typical file found in most (if not all) F# projects created with Visual Studio. For the most part, you should rarely need to touch this. The other seven files build out the project and are where you will do most of your work. With that in mind, I should point out "Scratchpad.fsx" operates in a different manner to the other six. That is because it is a script file and not part of the binary/DLL when you compile it. So, you can avoid using working with this file too if you want. + +FILE STRUCTURE IMAGE. diff --git a/Home.md b/Home.md index 2b136a1..2a8d793 100644 --- a/Home.md +++ b/Home.md @@ -56,6 +56,7 @@ Before continuing, I recommend you are familiar with the following; #### DeathSocket - [DeathSocket Home](DeathSocket-Home) +- [DeathSocket Project Breakdown](DeathSocket-Project-Breakdown) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) diff --git a/Source-Code-Home.md b/Source-Code-Home.md index 316f95f..d4a608d 100644 --- a/Source-Code-Home.md +++ b/Source-Code-Home.md @@ -11,6 +11,7 @@ This section is for those wanting to work with the repository's source code. If #### DeathSocket - [DeathSocket Home](DeathSocket-Home) +- [DeathSocket Project Breakdown](DeathSocket-Project-Breakdown) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) diff --git a/_sidebar.md b/_sidebar.md index b06e662..5900f6e 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -13,6 +13,7 @@ #### DeathSocket - [DeathSocket Home](DeathSocket-Home) +- [DeathSocket Project Breakdown](DeathSocket-Project-Breakdown) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow)