diff --git a/README.md b/README.md index f52de3f..e62d022 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Wet Pancake Banner](.github/wet-pancake-banner.png) +![Wet Pancake Banner](.github/Images/wet-pancake-banner.png) **Note: This project is a work in-progress.** @@ -18,7 +18,7 @@ Wet Pancake is a NuGet package which generates random text. The solution, also, ### 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. +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](https://github.com/CraigOates/Console.Waterworks) NuGet package worked with F# libraries. This meant I needed to learn F#. To do this, I used [FsMarkov](https://blog.taylorwood.io/2015/07/04/markov-text.html) 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](https://www.nuget.org/profiles/Craig.Oates) 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]() @@ -32,8 +32,8 @@ The solution consists of three projects. They are WetPancake (NuGet package), We 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. +1. [**MyGet:**](https://myget.org/gallery/the-immutable-null) 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](http://docs.myget.org/docs/walkthrough/getting-started-with-nuget). +2. [**NuGet:**](https://www.nuget.org/profiles/Craig.Oates) 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: @@ -49,11 +49,11 @@ PM> Install-Package Wet-Pancake- PM> Install-Package Wet-Pancake- ``` -For further information about this project, please visit the [wiki](). +For further information about this project, please visit the [wiki](https://github.com/CraigOates/Wet-Pancake/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](). +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](https://github.com/CraigOates/Console.Waterworks) to parse the commands so, if you want to extend it, I recommend you read its [wiki](https://github.com/CraigOates/Console.Waterworks/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](https://github.com/CraigOates/Wet-Pancake/wiki). ![Image of the GenerateRandomText in use]() @@ -67,24 +67,24 @@ This project holds all the tests for this solution. If uses a combination of uni Please visit the Contribution page for Wet Pancake at: -- [Contribution page]() -- [Issues]() -- [Bug Report Template]() -- [Feature Request Template]() -- [Pull Request Template]() -- [Custom Template]() +- [Contribution page](https://github.com/CraigOates/Wet-Pancake/blob/master/CONTRIBUTING.md) +- [Issues](https://github.com/CraigOates/Wet-Pancake/issues) +- [Bug Report Template](https://github.com/CraigOates/Wet-Pancake/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) +- [Feature Request Template](https://github.com/CraigOates/Wet-Pancake/blob/master/.github/ISSUE_TEMPLATE/feature_request.md) +- [Pull Request Template](https://github.com/CraigOates/Wet-Pancake/blob/master/PULL_REQUEST_TEMPLATE.md) +- [Custom Template](https://github.com/CraigOates/Wet-Pancake/blob/master/.github/ISSUE_TEMPLATE/custom.md) ## Code of Conduction Please visit the Code of Conduct page for Wet Pancake at: -- [Code of Conduct page]() -- [MIT License]() +- [Code of Conduct page](https://github.com/CraigOates/Wet-Pancake/blob/master/CODE_OF_CONDUCT.md) +- [MIT License](https://github.com/CraigOates/Wet-Pancake/blob/master/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) +- Email: [craig@craigoates.net](http://www.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