From a10a6e5bb74866398f3224ace4e39837109863ec Mon Sep 17 00:00:00 2001 From: "HOT-ROD\\craig" Date: Tue, 31 Jul 2018 01:59:29 +0100 Subject: [PATCH] Blocked out the Read Me and moved the banner. --- .../Images/wet-pancake-banner.png | Bin README.md | 92 +++++++++++++++++- 2 files changed, 90 insertions(+), 2 deletions(-) rename wet-pancake-banner.png => .github/Images/wet-pancake-banner.png (100%) diff --git a/wet-pancake-banner.png b/.github/Images/wet-pancake-banner.png similarity index 100% rename from wet-pancake-banner.png rename to .github/Images/wet-pancake-banner.png diff --git a/README.md b/README.md index 2eb9abf..f52de3f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,90 @@ -# Wet-Pancake -A test project to see how well Console.Waterworks based console programs work with F# libraries. Wet Pancake generates text using the world famous Markov chain. +![Wet Pancake Banner](.github/wet-pancake-banner.png) + +**Note: This project is a work in-progress.** + +# 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 [NuGe]()t 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. + +![Image of the CLI generating text]() + +## Wet Pancake: Solution + +The solution consists of three projects. They are WetPancake (NuGet package), WetPancakeCLI and TestCentre. + +![Image of the solution's structure]() + +### WetPancake (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 latests 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 [here]() for the most stable releases. + +You can add Wet Pancake to your project via the following commands: + +``` F# +// Using the built-in Package Manager console in Visual Studio. + +// MyGet + +PM> Install-Package Wet-Pancake- + +// NuGet + + PM> Install-Package Wet-Pancake- +``` + +For further information about this project, please visit the [wiki](). + +### WetPancakeCLI + +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](). + +![Image of the GenerateRandomText in use]() + +### TestCentre + +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. + +![Image of VS's Test Explorer]() + +## How to Contribute + +Please visit the Contribution page for Wet Pancake at: + +- [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](craig@craigoates.net) +- Web: [http://www.craigaotes.net](http://www.craigaotes.net) +- Project: [http://www.craigoates.net/Software/project/12](http://www.craigoates.net/Software/project/12) \ No newline at end of file