diff --git a/DeathSocket-Home.md b/DeathSocket-Home.md index 99aba72..13fbac3 100644 --- a/DeathSocket-Home.md +++ b/DeathSocket-Home.md @@ -4,3 +4,5 @@ This section focuses on the source code within the project called "DeathSocket". - [TestCentre](https://gitlab.com/craig.oates/Death-Socket/wikis/Test-Centre-Home) (testing library) ## Table of Contents + +- [DeathSocket's Flow](DeathSockets-Flow) diff --git a/DeathSockets-Flow.md b/DeathSockets-Flow.md new file mode 100644 index 0000000..aa2358f --- /dev/null +++ b/DeathSockets-Flow.md @@ -0,0 +1,7 @@ +To help you get up to speed on the way DeathSocket works, please consider the following image; + +IMAGE OF SYSTEM FLOW. + +The way it works is you construct an `ImageSpec` record, found in "Domain.fs". When you have done that, you call one of the functions in "GridPainter.fs". After that, the image creation process begins. This is done via the functions within the other files and your `ImageSpec`. While this is happening, the function in "GridPainter.fs" (housed in the `GridPainter` module) maintains overall control and essentially co-ordinates the task. + +**Note:** This is the general flow of the system. You will find some functions which do not need an `ImageSpec` and the above does not cover those exceptions. With that said, they are not as common as the main loop mentioned above. And, they will reveal themselves naturally when you get passed the initial learning curve. So, don't worry about them for now. diff --git a/Home.md b/Home.md index 943fa96..e3e288c 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's Flow](DeathSockets-Flow) #### DeathSocketCLI diff --git a/Source-Code-Home.md b/Source-Code-Home.md index 66fc00c..1ee357a 100644 --- a/Source-Code-Home.md +++ b/Source-Code-Home.md @@ -10,6 +10,9 @@ This section is for those wanting to work with the repository's source code. If #### DeathSocket +- [DeathSocket Home](DeathSocket-Home) +- [DeathSocket's Flow](DeathSockets-Flow) + #### DeathSocketCLI - [DeathSocketCLI Home](DeathSocketCLI-Home) diff --git a/_sidebar.md b/_sidebar.md index 2e51071..dbf6e66 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -13,6 +13,7 @@ #### DeathSocket - [DeathSocket Home](DeathSocket-Home) +- [DeathSocket's Flow](DeathSockets-Flow) #### DeathSocketCLI