Note: This project is a work in-progress. Doc's might be out-of-date

Summary

Wet Pancake is a NuGet package which generates random text. The solution, also, has a console program for those not needing to program against the package.

Pre-Requisites

• Visual Studio 2017
• F#
• C#
• XUnit
• FsCheck
• Console.Waterworks
• .Net 4.7

Disclaimer

This project started out as a test project. It was not my intention for it to grow to what it is now (granted, it is still not massive.) At first, I wanted to see how well the Console.Waterworks NuGet package worked with F# libraries. This meant I needed to learn F#. To do this, I used FsMarkov as a reference/goal to work towards. Because of these factors, the codebase has taken the shape it has. It did not start off with the best development practices. And, the fact, it is now a NuGet package, is a goal which came somewhat after the initial playing period. So, if you find yourself wanting to scream at me for glaring and obvious mistakes, please be kind. Thanks.

Wet Pancake: Solution

The solution consists of three projects. They are WetPancake (NuGet package), WetPancakeCLI and TestCentre.

Wet Pancake (Library/NuGet Package)

This is a F# library project, using .Net 4.7. You can install this package from two places:

1. MyGet: This is the testbed for my NuGet packages before they make there way over to nuget.org. The packages here are less stable but they are where you will find the latest bits to test out. If you are unsure how to subscribe to a MyGet feed, click here.
2. NuGet: This is the official host for NuGets. Download Wet Pancake from this feed for the most stable releases.

You can add Wet Pancake to your project via the following commands:

// Using the built-in Package Manager console in Visual Studio.
// Also, remove "< >" when inserting the package version.

// MyGet

PM> Install-Package WetPancake -Version <insert package here> -Source https://www.myget.org/F/the-immutable-null/api/v3/index.json

// NuGet

PM> Install-Package Wet-Pancake -Version <insert package here>

For further information about this project, please visit the wiki.

Wet Pancake CLI

This project is a C# console program, using .Net 4.7. You use it by entering commands and awaiting the result. It uses Console.Waterworks to parse the commands so, if you want to extend it, I recommend you read its wiki. If you want to get going straight away, I recommend using GenerateRandomText. For more commands, you can either type Help into the console or visit the wiki.

Test Centre

This project holds all the tests for this solution. If uses a combination of unit tests (XUnit) and property tests (FsCheck). If you are unfamiliar with either of them, click on their links for more information. Also, all the tests are accessible in Visual Studio's Test Explorer. This means you can identify failing tests with ease.

How to Contribute

If you would like to contribute to the project, first of all, thank you and here are some useful links for for you to get started.

• Contribution page
• Issues
• Bug Report Template
• Feature Request Template
• Pull Request Template
• Custom Template

Code of Conduction

Please visit the Code of Conduct page for Wet Pancake at:

• Code of Conduct page
• MIT License

About the Creator

Hi, my name is Craig and I am the creator of Wet Pancake. Thanks for checking it out.

• Email: craig@craigoates.net
• Web: http://www.craigaotes.net
• Project: http://www.craigoates.net/Software/project/12