Browse Source

port ReadMe to GitLab environment.

master
Craig Oates 5 years ago
parent
commit
e6441466e2
  1. 35
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 7
      .github/ISSUE_TEMPLATE/custom.md
  3. 17
      .github/ISSUE_TEMPLATE/feature_request.md
  4. 0
      .gitlab/Images/cli-generating-text.png
  5. 0
      .gitlab/Images/generate-random-text-example.png
  6. 0
      .gitlab/Images/solution-structure.png
  7. 0
      .gitlab/Images/test-explorer-example.png
  8. 0
      .gitlab/Images/wet-pancake-banner.png
  9. 0
      .gitlab/Images/wet-pancake-feed-logo.png
  10. 46
      CODE_OF_CONDUCT.md
  11. 1
      CONTRIBUTING.md
  12. 1
      PULL_REQUEST_TEMPLATE.md
  13. 68
      README.md

35
.github/ISSUE_TEMPLATE/bug_report.md

@ -1,35 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.

7
.github/ISSUE_TEMPLATE/custom.md

@ -1,7 +0,0 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
---

17
.github/ISSUE_TEMPLATE/feature_request.md

@ -1,17 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

0
.github/Images/cli-generating-text.png → .gitlab/Images/cli-generating-text.png

Before

Width:  |  Height:  |  Size: 626 KiB

After

Width:  |  Height:  |  Size: 626 KiB

0
.github/Images/generate-random-text-example.png → .gitlab/Images/generate-random-text-example.png

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

0
.github/Images/solution-structure.png → .gitlab/Images/solution-structure.png

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

0
.github/Images/test-explorer-example.png → .gitlab/Images/test-explorer-example.png

Before

Width:  |  Height:  |  Size: 104 KiB

After

Width:  |  Height:  |  Size: 104 KiB

0
.github/Images/wet-pancake-banner.png → .gitlab/Images/wet-pancake-banner.png

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

0
.github/Images/wet-pancake-feed-logo.png → .gitlab/Images/wet-pancake-feed-logo.png

Before

Width:  |  Height:  |  Size: 6.8 KiB

After

Width:  |  Height:  |  Size: 6.8 KiB

46
CODE_OF_CONDUCT.md

@ -1,46 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at craig@craigoates.net. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

1
CONTRIBUTING.md

@ -1 +0,0 @@
This needs adding to at a later date.

1
PULL_REQUEST_TEMPLATE.md

@ -1 +0,0 @@
This needs adding to at a later date.

68
README.md

@ -1,10 +1,8 @@
![Wet Pancake Banner](.github/Images/wet-pancake-banner.png)
**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.
WetPancake consists of a .Net 4.7 library, a console program and a testing library. The purpose of this repository is to provide a way for people to generate random "placeholder text" -- with a Markov Chain. It does this by making the .Net 4.7 library available on NuGet and providing a console program which exposes the features of the library. The console program is a stand-alone one so no installer is required to run it.
## Pre-Requisites
@ -16,76 +14,36 @@ Wet Pancake is a NuGet package which generates random text. The solution, also,
- 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](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](.github/Images/cli-generating-text.png)
## Wet Pancake: Solution
The solution consists of three projects. They are WetPancake (NuGet package), WetPancakeCLI and TestCentre.
![Image of the solution's structure](.github/Images/solution-structure.png)
### 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:**](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.
This is a F# library project, using .Net 4.7. You can install this package with NuGet. The profile page for WetPancake is available at [www.nuget.org/profiles/Craig.Oates](https://www.nuget.org/profiles/Craig.Oates).
You can add Wet Pancake to your project via the following commands:
You can add Wet Pancake to your project via the following command (using the Package Manager console):
``` powershell
// 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>
// Remember to enter the package version you want.
Install-Package WetPancake -Version 1.0.0
```
For further information about this project, please visit the [wiki](https://github.com/CraigOates/Wet-Pancake/wiki).
For further information about this project, please visit the [wiki](https://gitlab.com/craig.oates/Wet-Pancake/wikis/home).
### 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](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).
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://gitlab.com/craig.oates/Console.Waterworks) to parse the commands so, if you want to extend it, I recommend you read its [wiki](https://gitlab.com/craig.oates/Console.Waterworks/wikis/home). 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://gitlab.com/craig.oates/Wet-Pancake/wikis/home).
![Image of the GenerateRandomText in use](.github/Images/generate-random-text-example.png)
![Image of the CLI generating text](.gitlab/Images/cli-generating-text.png)
### Test Centre
This project holds all the tests for this solution. If uses a combination of unit tests ([XUnit](http://xunit.github.io/)) and property tests ([FsCheck](https://fscheck.github.io/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](.github/Images/test-explorer-example.png)
## 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](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](https://github.com/CraigOates/Wet-Pancake/blob/master/CODE_OF_CONDUCT.md)
- [MIT License](https://github.com/CraigOates/Wet-Pancake/blob/master/LICENSE)
![Image of VS's Test Explorer](.gitlab/Images/test-explorer-example.png)
## 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](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)
- Web: [http://www.craigoates.net](http://www.craigoates.net)
- Email: [craig@craigoates.net](mailto:craig@craigoates.net)
- Project: [http://www.craigoates.net/Software/project/12](http://www.craigoates.net/Software/project/12)

Loading…
Cancel
Save