1 changed files with 71 additions and 71 deletions
@ -1,71 +1,71 @@
|
||||
- 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/Wet-Pancake/blob/master/LICENSE) |
||||
|
||||
Welcome to the wiki of Wet Pancake. The aim of this wiki is to teach you how to use Wet Pancake -- as a NuGet package and 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, on the 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+](https://dotnet.microsoft.com) |
||||
- [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 Wet Pancake as "W.P." |
||||
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" and I will refer to it as "TestCentre" throughout the wiki. |
||||
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 Wet Pancake](Introduction-to-Wet-Pancake) |
||||
- [Repository Breakdown](Repository-Breakdown) |
||||
- [Markov Chain Overview](Markov-Chain-Overview) |
||||
|
||||
### As Source Code |
||||
|
||||
- [As Source Code section](Source-Code-Home) |
||||
|
||||
#### WetPancake |
||||
|
||||
- [WetPancake Home](WetPancake-Home) |
||||
- [WetPancake Project Breakdown](WetPancake-Project-Breakdown) |
||||
- [WetPancake's Flow](WetPancakes-Flow) |
||||
- [Creating Template Files](Creating-Template-Files) |
||||
|
||||
#### WetPancakeCLI |
||||
|
||||
- [WetPancakeCLI Home](WetPancakeCLI-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) |
||||
|
||||
#### TestCentre |
||||
|
||||
- [TestCentre Home](TestCentre-Home) |
||||
- [TestCentre Breakdown](TestCentre-Breakdown) |
||||
- [Unit and Property Tests Overview](Unit-and-Property-Tests-Overview) |
||||
|
||||
#### As a Command-Line Interface (C.L.I.) |
||||
|
||||
- [C.L.I. Home](CLI-Home) |
||||
- [Add WetPancakeCLI to Your Machine](Add-WetPancakeCLI-to-Your-Machine) |
||||
- [Using the Console Program](Using-the-Console-Program) |
||||
- [Console A.P.I.](Console-API) |
||||
|
||||
### As a NuGet |
||||
|
||||
- [NuGet Home](NuGet-Home) |
||||
- [Add NuGet to Your Project](Add-NuGet-to-Your-Project) |
||||
- [Using WetPancake](Using-WetPancake) |
||||
- [NuGet A.P.I.](NuGet-API) |
||||
- 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/Wet-Pancake/src/branch/master/LICENSE) |
||||
|
||||
Welcome to the wiki of Wet Pancake. The aim of this wiki is to teach you how to use Wet Pancake -- as a NuGet package and 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, on the 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+](https://dotnet.microsoft.com) |
||||
- [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 Wet Pancake as "W.P." |
||||
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" and I will refer to it as "TestCentre" throughout the wiki. |
||||
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 Wet Pancake](Introduction-to-Wet-Pancake) |
||||
- [Repository Breakdown](Repository-Breakdown) |
||||
- [Markov Chain Overview](Markov-Chain-Overview) |
||||
|
||||
### As Source Code |
||||
|
||||
- [As Source Code section](Source-Code-Home) |
||||
|
||||
#### WetPancake |
||||
|
||||
- [WetPancake Home](WetPancake-Home) |
||||
- [WetPancake Project Breakdown](WetPancake-Project-Breakdown) |
||||
- [WetPancake's Flow](WetPancakes-Flow) |
||||
- [Creating Template Files](Creating-Template-Files) |
||||
|
||||
#### WetPancakeCLI |
||||
|
||||
- [WetPancakeCLI Home](WetPancakeCLI-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) |
||||
|
||||
#### TestCentre |
||||
|
||||
- [TestCentre Home](TestCentre-Home) |
||||
- [TestCentre Breakdown](TestCentre-Breakdown) |
||||
- [Unit and Property Tests Overview](Unit-and-Property-Tests-Overview) |
||||
|
||||
#### As a Command-Line Interface (C.L.I.) |
||||
|
||||
- [C.L.I. Home](CLI-Home) |
||||
- [Add WetPancakeCLI to Your Machine](Add-WetPancakeCLI-to-Your-Machine) |
||||
- [Using the Console Program](Using-the-Console-Program) |
||||
- [Console A.P.I.](Console-API) |
||||
|
||||
### As a NuGet |
||||
|
||||
- [NuGet Home](NuGet-Home) |
||||
- [Add NuGet to Your Project](Add-NuGet-to-Your-Project) |
||||
- [Using WetPancake](Using-WetPancake) |
||||
- [NuGet A.P.I.](NuGet-API) |
||||
|
||||
Loading…
Reference in new issue