Browse Source

change GitHub stuff to GitLab.

master
Craig Oates 5 years ago
parent
commit
f69af94d6c
  1. 0
      .gitlab/ISSUE_TEMPLATE/bug_report.md
  2. 0
      .gitlab/ISSUE_TEMPLATE/custom.md
  3. 0
      .gitlab/ISSUE_TEMPLATE/feature_request.md
  4. 0
      .gitlab/Images/nuget-icon.png
  5. 0
      .gitlab/Images/repo-banner.png
  6. 0
      .gitlab/Images/screenshot-1.png
  7. 0
      .gitlab/Images/screenshot-2.png
  8. 0
      .gitlab/Images/solution-structure.png
  9. 46
      CODE_OF_CONDUCT.md
  10. 1
      CONTRIBUTING.md
  11. 1
      PULL_REQUEST_TEMPLATE.md
  12. 80
      README.md
  13. 3
      TestCentre/TestCentre.fsproj

0
.github/ISSUE_TEMPLATE/bug_report.md → .gitlab/ISSUE_TEMPLATE/bug_report.md

0
.github/ISSUE_TEMPLATE/custom.md → .gitlab/ISSUE_TEMPLATE/custom.md

0
.github/ISSUE_TEMPLATE/feature_request.md → .gitlab/ISSUE_TEMPLATE/feature_request.md

0
.github/Images/nuget-icon.png → .gitlab/Images/nuget-icon.png

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

0
.github/Images/repo-banner.png → .gitlab/Images/repo-banner.png

Before

Width:  |  Height:  |  Size: 7.5 KiB

After

Width:  |  Height:  |  Size: 7.5 KiB

0
.github/Images/screenshot-1.png → .gitlab/Images/screenshot-1.png

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

0
.github/Images/screenshot-2.png → .gitlab/Images/screenshot-2.png

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

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

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 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 @@
Under construction...

1
PULL_REQUEST_TEMPLATE.md

@ -1 +0,0 @@
Under construction...

80
README.md

@ -1,83 +1,57 @@
# ![repo-banner](.github/Images/repo-banner.png)
**Note: This project is a work in-progress. Doc's might be out-of-date.**
# ![repo-banner](.gitlab/Images/repo-banner.png)
## Summary
Smouldering Beach Ball consists of  a .Net Standard 2.0 library, a console program and a "Test Centre". The purpose of this repository is to provide a way for people to create placeholder images. It does this by making the library available as a NuGet and providing a console program. The console program is useful for those needing access to the functionality and not the code. If you are one of the people wanting the features and not the code, I recommend downloading the CLI in [Releases](https://github.com/CraigOates/Smouldering-Beach-Ball/releases). It is a standard alone program so there is no install "concerns".
Smouldering Beach Ball consists of  a .Net Standard 2.0 library, a console program and a "Test Centre". The purpose of this repository is to provide a way for people to create placeholder images. It does this by making the library available as a NuGet package and providing a console program. The console program is a standard alone program so there is no installer..
### Pre-Requisites
* Visual Studio 2017
* F#
* xUnit
* FsCheck
* Console.Waterworks
* .Net 4.7
* .Net Standard
![solution-structure](.github/Images/solution-structure.png)
## Smouldering Beach Ball (Library/NuGet Package)
- Visual Studio 2017+
- F# (4.1+)
- xUnit
- FsCheck
- Console.Waterworks
- .Net 4.7
- .Net Standard (2.0)
This is a F# .Net Standard library. You can install this package from two places:
## SmoulderingBeachBall (Library/NuGet Package)
1. [MyGet](https://www.myget.org/feed/the-immutable-null/package/nuget/SmoulderingBeachBall): This is the test-bed for the NuGet packages before they make there way over to nuget.org. The packages are less stable but they are where you will 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 Smouldering Beach Ball from this feed for the most stable releases.
You can add Smouldering Beach Ball to your project via the following commands:
This is a F# .Net Standard library. You can install this package via the Package Manager Console with the following command;
```powershell
// Using the built-in Package Manager console in Visual Studio.
// Also, remove the "< >" when inserting the package version.
// Make sure you change the version number to the one you want.
Install-Package SmoulderingBeachBall -Version 1.0.0
```
// MyGet
PM> Install-Package SmoulderingBeachBall -Version <insert package here> -Source https://www.myget.org/F/the-immutable-null/api/v3/index.json 
If you are using the .Net CLI, you can use the following command;
// NuGet
PM> Install-Package SmoulderingBeachBall -Version <insert package here>
```powershell
// Again, make sure you change the version number to the one you want.
dotnet add package SmoulderingBeachBall --version 1.0.0
```
For further information about this project, please visit the [wiki](https://github.com/CraigOates/Smouldering-Beach-Ball/wiki).
For further information about this project, please visit the [wiki](https://gitlab.com/craig.oates/Smouldering-Beach-Ball/wikis/home).
## Smouldering Beach Ball CLI
This project is an F# console program, uses .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/Smouldering-Beach-Ball/wiki). If you want to get going straight away, I recommend using the ``draw-default`` command. All you need to specify is the width and height of the image and it will create an image and save it to your desktop.
This project is an F# console program, built on top of .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 the ``draw-default`` command. All you need to specify is the width and height of the image and it will create an image and save it to your desktop.
**Tip: Enter ``help`` for a list of available commands or ``cheat`` if you prefer them rendered in a PDF with a nicer layout. The CLI will save the PDF on your desktop.**
**Tip: Enter ``help`` for a list of available commands or ``cheat`` if you prefer them rendered in a PDF with a nicer layout. The command line interface(C.L.I.) will save the PDF on your desktop.**
For further information about this project, please visit the [wiki](https://github.com/CraigOates/Smouldering-Beach-Ball/wiki).
For further information, please visit the [wiki](https://gitlab.com/craig.oates/Smouldering-Beach-Ball/wikis/home).
![screenshot-1](.github/Images/screenshot-1.png)
![screenshot-1](.gitlab/Images/screenshot-1.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.
![screenshot-2](.github/Images/screenshot-2.png)
## How to Contribute
If you would like to contribute to the project, thank you and here are some useful links for for you to get started.
* [Contribution page](https://github.com/CraigOates/Smouldering-Beach-Ball/blob/master/CONTRIBUTING.md)
* [Issues](https://github.com/CraigOates/Smouldering-Beach-Ball/tree/master/.github/ISSUE_TEMPLATE)
* [Bug Report Template](https://github.com/CraigOates/Smouldering-Beach-Ball/blob/master/.github/ISSUE_TEMPLATE/bug_report.md)
* [Feature Request Template](https://github.com/CraigOates/Smouldering-Beach-Ball/blob/master/.github/ISSUE_TEMPLATE/feature_request.md)
* [Pull Request Template](https://github.com/CraigOates/Smouldering-Beach-Ball/blob/master/PULL_REQUEST_TEMPLATE.md)
* [Custom Template](https://github.com/CraigOates/Smouldering-Beach-Ball/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/Smouldering-Beach-Ball/blob/master/CODE_OF_CONDUCT.md)
* [MIT License](https://github.com/CraigOates/Smouldering-Beach-Ball/blob/master/LICENSE)
![screenshot-2](.gitlab/Images/screenshot-2.png)
## About the Creator
Hi, my name is Craig and I am the creator of Smouldering Beach Ball. Thanks for checking it out.
* Email: craig@craigoates.net
* Web: [http://www.craigoates.net](http://www.craigoates.net/)
* Project:  [http://www.craigoates.net/Software/project/11](http://www.craigoates.net/Software/project/11)
- Email: craig@craigoates.net
- Web: [http://www.craigoates.net](http://www.craigoates.net/)
- Project:  [http://www.craigoates.net/Software/project/11](http://www.craigoates.net/Software/project/11)

3
TestCentre/TestCentre.fsproj

@ -45,9 +45,6 @@
</PropertyGroup>
<Import Project="$(FSharpTargetsPath)" />
<ItemGroup>
<Content Include="SavingTestArea\folder-info.txt">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<Compile Include="AssemblyInfo.fs" />
<Compile Include="ConsoleTests.fs" />
<Compile Include="LibraryTests.fs" />

Loading…
Cancel
Save