34 Home
Craig Oates edited this page 1 year ago

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:

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

As Source Code

SmoulderingBeachBall

SmoulderingBeachBallCLI

TestCentre

As a Command-Line Interface (C.L.I.)

As a NuGet