add initial outline to home.

master
Craig Oates 5 years ago
parent
commit
d56ab6a0f6
  1. 34
      Home.md

34
Home.md

@ -1 +1,33 @@
The wiki is yet to be written.
* Created by: Craig Oates
* Web: craigoates.net
* Email: craig@craigoates.net
* License: MIT
Welcome to the wiki of Smouldering Beach Ball. The aim of this wiki is to teach you how to use Smouldering Beach Ball -- as a NuGet 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:
* Visual Studio 2017
* F#
* xUnit
* FsCheck
* Console.Waterworks
* .Net 4.7
* .Net Standard
## Notes on Writing Style
1. Because Smouldering Beach Ball is wordy, I will usually refer to it as S.B.B.
2. I will use "console program" and "console project" interchangeably. This because 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 "Test Centre" throughout the wiki.
## Links
* Table of Contents
* Introduction to Smouldering Beach Ball
* As Source Code
* As a CLI
* As a NuGet
* Code Snippets

Loading…
Cancel
Save