1 changed files with 21 additions and 23 deletions
@ -1,33 +1,31 @@
|
||||
* Created by: Craig Oates |
||||
* Web: craigoates.net |
||||
* Email: craig@craigoates.net |
||||
* License: MIT |
||||
- Created by: Craig Oates |
||||
- Web:[craigoates.net](http://www.craigoates.net) |
||||
- Email: [craig@craigoates.net](mailto:craig@craigoates.net) |
||||
- License: [MIT](https://gitlab.com/craig.oates/Smouldering-Beach-Ball/blob/master/LICENSE) |
||||
|
||||
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. |
||||
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 package and a command line interface (C.L,I.). 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 (to your right) or the links below to navigate to the section you want. |
||||
|
||||
## Pre-Requisites |
||||
|
||||
Before continuing, I recommend you are familiar with the following: |
||||
Before continuing, I recommend you are familiar with the following; |
||||
|
||||
* Visual Studio 2017 |
||||
* F# |
||||
* xUnit |
||||
* FsCheck |
||||
* Console.Waterworks |
||||
* .Net 4.7 |
||||
* .Net Standard |
||||
- [.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) |
||||
|
||||
## 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. |
||||
1. I will usually refer to Smouldering Beach Ball 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 "TestCentre". I will refer to it as such throughout the wiki. (Just wanting to minimise the confusion). |
||||
4. The console project uses a NuGet package called Console.Waterworks. I will usually refer to it 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. |
||||
|
||||
## Links |
||||
## Table of Contents |
||||
|
||||
* Table of Contents |
||||
* Introduction to Smouldering Beach Ball |
||||
* As Source Code |
||||
* As a CLI |
||||
* As a NuGet |
||||
* Code Snippets |
||||
Will be added to when this thing begins to grow. |
||||
|
||||
Loading…
Reference in new issue