Browse Source

update README and add images for README.

Make a new Images folder in .github.
master
Craig Oates 6 years ago
parent
commit
7c3b561da9
  1. BIN
      .github/Images/repo-banner.png
  2. BIN
      .github/Images/screenshot-1.png
  3. BIN
      .github/Images/screenshot-2.PNG
  4. BIN
      .github/Images/solution-structure.png
  5. 85
      README.md

BIN
.github/Images/repo-banner.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

BIN
.github/Images/screenshot-1.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
.github/Images/screenshot-2.PNG

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
.github/Images/solution-structure.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

85
README.md

@ -1,2 +1,83 @@
# Smouldering-Beach-Ball
A F# project for creating placeholder images. Then intention is to create a NuGet package and a console program.
# ![repo-banner](B:\Work\SmoulderingBeachBall\readme\attachments\repo-banner.png)
**Note: This project is a work in-progress. Doc's might be out-of-date.**
## 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".
### 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)
This is a F# .Net Standard library. You can install this package from two places:
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:
```powershell
// Using the built-in Package Manager console in Visual Studio.
// Also, remove the "< >" when inserting the package version.
// MyGet
PM> Install-Package SmoulderingBeachBall -Version <insert package here> -Source https://www.myget.org/F/the-immutable-null/api/v3/index.json 
// NuGet
PM> Install-Package SmoulderingBeachBall -Version <insert package here>
```
For further information about this project, please visit the [wiki](https://github.com/CraigOates/Smouldering-Beach-Ball/wiki).
## 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.
**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.**
For further information about this project, please visit the [wiki](https://github.com/CraigOates/Smouldering-Beach-Ball/wiki).
![screenshot-1](.github/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)
## 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.craigaotes.net](http://www.craigaotes.net/)
* Project:  [http://www.craigoates.net/Software/project/11](http://www.craigoates.net/Software/project/11)
Loading…
Cancel
Save