craig.oates
/
smouldering-beach-ball
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

master
Craig Oates 4 years ago
parent
3c257b57a0
commit
0130610619
1 changed files with 74 additions and 74 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 148
      Home.md

148
Home.md
Unescape

@ -1,74 +1,74 @@
- Created by: Craig Oates
- Web: [craigoates.net](http://www.craigoates.net)
- Email: [craig@craigoates.net](mailto:craig@craigoates.net)
- License: [MIT](https://git.abbether.net/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 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:
- [.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://git.abbether.net/craig.oates/Console.Waterworks)
## Notes on Writing Style
1. I will usually refer to Smouldering Beach Ball as "S.B.B".
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 "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.
## Table of Contents
- [Introduction to Smouldering Beach Ball](Introduction-to-Smouldering-Beach-Ball)
- [Repository Breakdown](Repository-Breakdown)
### As Source Code
- [Source Code Home](Source-Code-Home)
#### SmoulderingBeachBall
- [SmoulderingBeachBall Home](SmoulderingBeachBall-Home)
- [SmoulderingBeachBall Project Breakdown](SmoulderingBeachBall-Project-Breakdown)
- [SmoulderingBeachBall's Flow](SmoulderingBeachBalls-Flow)
#### SmoulderingBeachBallCLI
- [SmoulderingBeachBallCLI Home](SmoulderingBeachBallCLI-Home)
- [C.L.I. Project Breakdown](CLI-Project-Breakdown)
- [The C.L.I's Flow](The-CLIs-Flow)
- [Creating the Input-loop](Creating-the-Input-Loop)
- [Command-Methods Overview](Command-Methods-Overview)
- [C.L.I. Validation Overview](CLI-Validation-Overview)
- [Changing the C.L.I. Icon](Changing-the-CLI-Icon)
#### TestCentre
- [TestCentre Home](TestCentre-Home)
- [TestCentre Breakdown](TestCentre-Breakdown)
- [Unit and Property Tests Overview](Unit-and-Property-Tests-Overview)
- [Console and Library Tests Overview](Console-and-Library-Tests-Overview)
### As a Command-Line Interface (C.L.I.)
- [C.L.I. Home](CLI-Home)
- [Add SmoulderingBeachBallCLI to Your Machine](Add-SmoulderingBeachBallCLI-to-Your-Machine)
- [Using the Console Program](Using-the-Console-Program)
- [Console A.P.I.](Console-API)
- [C.L.I. Aliases](CLI-Aliases)
### As a NuGet
- [NuGet Home](NuGet-Home)
- [Add Smouldering Beach Ball to Your Project](Add-Smouldering-Beach-Ball-to-Your-Project)
- [The Domain Name-Space](The-Domain-Name-Space)
- [Using Smouldering Beach Ball in Your Project](Using-Smouldering-Beach-Ball-in-Your-Project)
- Created by: Craig Oates
- Web: [craigoates.net](http://www.craigoates.net)
- Email: [craig@craigoates.net](mailto:craig@craigoates.net)
- License: [MIT](https://git.abbether.net/craig.oates/Smouldering-Beach-Ball/src/branch/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 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:
- [.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://git.abbether.net/craig.oates/Console.Waterworks)
## Notes on Writing Style
1. I will usually refer to Smouldering Beach Ball as "S.B.B".
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 "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.
## Table of Contents
- [Introduction to Smouldering Beach Ball](Introduction-to-Smouldering-Beach-Ball)
- [Repository Breakdown](Repository-Breakdown)
### As Source Code
- [Source Code Home](Source-Code-Home)
#### SmoulderingBeachBall
- [SmoulderingBeachBall Home](SmoulderingBeachBall-Home)
- [SmoulderingBeachBall Project Breakdown](SmoulderingBeachBall-Project-Breakdown)
- [SmoulderingBeachBall's Flow](SmoulderingBeachBalls-Flow)
#### SmoulderingBeachBallCLI
- [SmoulderingBeachBallCLI Home](SmoulderingBeachBallCLI-Home)
- [C.L.I. Project Breakdown](CLI-Project-Breakdown)
- [The C.L.I's Flow](The-CLIs-Flow)
- [Creating the Input-loop](Creating-the-Input-Loop)
- [Command-Methods Overview](Command-Methods-Overview)
- [C.L.I. Validation Overview](CLI-Validation-Overview)
- [Changing the C.L.I. Icon](Changing-the-CLI-Icon)
#### TestCentre
- [TestCentre Home](TestCentre-Home)
- [TestCentre Breakdown](TestCentre-Breakdown)
- [Unit and Property Tests Overview](Unit-and-Property-Tests-Overview)
- [Console and Library Tests Overview](Console-and-Library-Tests-Overview)
### As a Command-Line Interface (C.L.I.)
- [C.L.I. Home](CLI-Home)
- [Add SmoulderingBeachBallCLI to Your Machine](Add-SmoulderingBeachBallCLI-to-Your-Machine)
- [Using the Console Program](Using-the-Console-Program)
- [Console A.P.I.](Console-API)
- [C.L.I. Aliases](CLI-Aliases)
### As a NuGet
- [NuGet Home](NuGet-Home)
- [Add Smouldering Beach Ball to Your Project](Add-Smouldering-Beach-Ball-to-Your-Project)
- [The Domain Name-Space](The-Domain-Name-Space)
- [Using Smouldering Beach Ball in Your Project](Using-Smouldering-Beach-Ball-in-Your-Project)

Write Preview
Loading…
Cancel
Save