41
Home
Craig Oates edited this page 4 years ago
- Created by: Craig Oates
- Web: craigoates.net
- Email: 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+
- .Net Standard
- Visual Studio 17 (15.3.9+)
- F# 4.1+
- NuGet
- xUnit
- FsCheck
- Console.Waterworks
- SkiaSharp
- System.Drawing
Notes on Writing Style
- I will often refer to Death Socket as D.S.
- 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.
- The repository has a testing library called "Test Centre". I will refer to it as this (instead of "testing library") throughout the wiki.
- The console project uses a NuGet package called Console.Waterworks. I will usually refer to it as "C.W."
- 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
As Source Code
DeathSocket
- DeathSocket Home
- DeathSocket Project Breakdown
- DeathSocket's Main Files Overview
- DeathSocket's Flow
- DeathSocket's Internal Flow
- ScratchPad Overview
DeathSocketCLI
- DeathSocketCLI Home
- C.L.I. Project Breakdown
- The C.L.I's Flow
- Creating the Input-loop
- Command-Methods Overview
- C.L.I. Validation Overview
- Changing the C.L.I. Icon
TestCentre
- TestCentre Home
- TestCentre Breakdown
- Property and Unit Tests Overview
- Console and Library Tests Overview
As a Command-Line Interface (C.L.I.)
- C.L.I. Home
- Add DeathSocketCLI to Your Machine
- Using the Console Program
- Console A.P.I.
- C.L.I. Aliases