From 4e4cc401f9aef3b7c2cf909b8057a57273ae6edc Mon Sep 17 00:00:00 2001 From: Craig Oates Date: Mon, 17 Jun 2019 14:02:19 +0000 Subject: [PATCH] Create home --- Home.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..50e024a --- /dev/null +++ b/Home.md @@ -0,0 +1,55 @@ +* Created by: Craig Oates +* Web: craigoates.net +* Email: [craig@craigoates.net](mailto:craig@craigoates.net) +* License: MIT + +Welcome to the wiki of Death Socket. The aim of this wiki is to teach +you how to use Death Socket -- as a NuGet package and CLI. If you want +to work within the repositories source code, this wiki will, also, +show you how to do that. Feel free to use the sidebar or the links +below to navigate to the section you want. + +## Pre-Requisites + +Before continuing, I recommend you are familiar with the following; + +* [.Net 4.7+ and .Net Core 2.0+](https://dotnet.microsoft.com) +* [.Net Standard](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) +* [Visual Studio 17 (15.3.9+)](https://visualstudio.microsoft.com) +* [F# 4.1+](https://fsharp.org) +* [NuGet](https://www.nuget.org) +* [xUnit](https://xunit.net/) +* [FsCheck](https://fscheck.github.io/FsCheck/) +* [Console.Waterworks](https://gitlab.com/craig.oates/Console.Waterworks) +* [SkiaSharp](https://github.com/mono/SkiaSharp) +* [System.Drawing](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.graphics?view=netframework-4.8) + +## Notes on Writing Style + +1. I will often refer to Death Socket as D.S. +2. I will use "console program" and "console project" + interchangeably. This is because of how Visual Studio's "file + system" works. Overall, there is a "solution" which holds + "projects". A project can consist of things like a console + program. In-effect, this makes it a "program" and a + "project". Hopefully, this makes sense when viewed in context. +3. The repository has a testing library called "Test Centre". I will + refer to it as this (instead of "testing library") throughout the + wiki. +4. The console project uses a NuGet package called + Console.Waterworks. I will usually refer to as "C.W." +5. In an attempt to keep a level of consistency, I will abbreviate + words with a full-stop. So, "HTML" will be written as + H.T.M.L. This is because I usually abbreviate "non-tech." words + this way and I am not keen on using the different styles in the + same text. + +## Table of Contents + +**TODO: Write-up when paged added.** + +* Introduction to Death Socket +* As Source Code +* As a CLI +* As a NuGet +* Code Snippets