diff --git a/DeathSocket-Home.md b/DeathSocket-Home.md index 1661e9a..77d850f 100644 --- a/DeathSocket-Home.md +++ b/DeathSocket-Home.md @@ -9,3 +9,4 @@ This section focuses on the source code within the project called "DeathSocket". - [DeathSocket's Main Files Overview](DeathSockets-Main-Files-Overview) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) +- [ScratchPad Overview](ScratchPad-Overview) diff --git a/Home.md b/Home.md index 3e5ea71..84bea1b 100644 --- a/Home.md +++ b/Home.md @@ -60,6 +60,7 @@ Before continuing, I recommend you are familiar with the following; - [DeathSocket's Main Files Overview](DeathSockets-Main-Files-Overview) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) +- [ScratchPad Overview](ScratchPad-Overview) #### DeathSocketCLI diff --git a/ScratchPad-Overview.md b/ScratchPad-Overview.md new file mode 100644 index 0000000..ec80b5a --- /dev/null +++ b/ScratchPad-Overview.md @@ -0,0 +1,18 @@ +The reason "ScratchPad.fsx" exists is to provide a way for you to interact with the code via F# Interactive (FSI). If you are new to the project, this is a good place to start. All the code within here has comments to help signify what it is doing or which part of the library it is using. So, I will avoid going through each line of code here and provide a link to the actual file for you. If you are unsure what F# Interactive is or how to use it, I have provided a link for that, also. They are as follows; + +- [ScratchPad.fsx](https://gitlab.com/craig.oates/Death-Socket/blob/master/DeathSocket/ScratchPad.fsx) +- [F# Interactive (FSI)](https://docs.microsoft.com/en-us/dotnet/fsharp/tutorials/fsharp-interactive/) +- [Scripting with F#](https://fsharpforfunandprofit.com/installing-and-using/) (it's a little dated but it contains enough information to get you going) + +IMAGE OF SCRATCH PAD RELATIONSHIP. + +If you decide to use "ScratchPad.fsx", you must build the project ("F5" in Visual Studio) beforehand. On top of that, you must change the path when referencing the "SkiaSharp" DLL. This is because I have hard-coded the path (yes, I'm lazy). So, within "ScratchPad.fsx", you should see something like the following at the top of the file, + +```f#// These paths need adjusting to match your computer. #r @"C:/Users/craig/.nuget/packages/skiasharp/1.60.3/lib/netstandard1.3/SkiaSharp.dll" // Currently not working...  + +//#r @"C:/Users/craig/.nuget/packages/skiasharp/1.60.3/runtimes/win-x64/native/libSkiaSharp.dll" +``` + +Hopefully, the only thing you need to replace is `craig` with your username. + +Last of all, I must ask you to consider all the code in "ScratchPad.fsx" as "throw-away" code. Although I have made an effort to organise it and add comments to make it easier to read, it is not part of the main library code. The file only exists for you to quickly test new ideas out and established code still works. It, also, operates as a "quick start guide" but that is a by-product I am exploiting. If I/you need to, this code can/should be deleted and replaced. diff --git a/Source-Code-Home.md b/Source-Code-Home.md index 4cbc822..c7dfd78 100644 --- a/Source-Code-Home.md +++ b/Source-Code-Home.md @@ -15,6 +15,7 @@ This section is for those wanting to work with the repository's source code. If - [DeathSocket's Main Files Overview](DeathSockets-Main-Files-Overview) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) +- [ScratchPad Overview](ScratchPad-Overview) #### DeathSocketCLI diff --git a/TestCentre-Breakdown.md b/TestCentre-Breakdown.md index 1571fe3..20e14a0 100644 --- a/TestCentre-Breakdown.md +++ b/TestCentre-Breakdown.md @@ -22,5 +22,5 @@ If you find any of your tests failing, cross-reference the names of the failing If you are unfamiliar with using F# scripts and F# Interactive (FSI), please use the following links; -- [F# Interactive (FSI](https://docs.microsoft.com/en-us/dotnet/fsharp/tutorials/fsharp-interactive/) +- [F# Interactive (FSI])(https://docs.microsoft.com/en-us/dotnet/fsharp/tutorials/fsharp-interactive/) - [Scripting with F#](https://fsharpforfunandprofit.com/installing-and-using/) (it's a little dated but it contains enough information to get you going) diff --git a/_sidebar.md b/_sidebar.md index 3f39eed..3c95401 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -17,6 +17,7 @@ - [DeathSocket's Main Files Overview](DeathSockets-Main-Files-Overview) - [DeathSocket's Flow](DeathSockets-Flow) - [DeathSocket's Internal Flow](DeathSockets-Internal-Flow) +- [ScratchPad Overview](ScratchPad-Overview) #### DeathSocketCLI