diff --git a/.github/Images/death-socket-demo.gif b/.github/Images/death-socket-demo.gif new file mode 100644 index 0000000..1e6457c Binary files /dev/null and b/.github/Images/death-socket-demo.gif differ diff --git a/.github/Images/death-socket-output-sample.jpg b/.github/Images/death-socket-output-sample.jpg new file mode 100644 index 0000000..3a2ed89 Binary files /dev/null and b/.github/Images/death-socket-output-sample.jpg differ diff --git a/.github/Images/death-socket-overview.png b/.github/Images/death-socket-overview.png new file mode 100644 index 0000000..9cb333e Binary files /dev/null and b/.github/Images/death-socket-overview.png differ diff --git a/.github/Images/repo-banner.png b/.github/Images/repo-banner.png new file mode 100644 index 0000000..f3b7276 Binary files /dev/null and b/.github/Images/repo-banner.png differ diff --git a/.github/Images/test-explorer.JPG b/.github/Images/test-explorer.JPG new file mode 100644 index 0000000..ba8a1ec Binary files /dev/null and b/.github/Images/test-explorer.JPG differ diff --git a/README.md b/README.md index 07b31b9..4680804 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,77 @@ -# Death-Socket -A .Net standard library and console project for creating a gridded image. In other words, those things a painter uses to as a reference. This project is written in F#. +![repo-banner](.github/Images/repo-banner.png) + +## Summary + +Death Socket consists on three projects. They are 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 add grids to images. + +![death-socket-overview](.github/Images/death-socket-output-sample.jpg) + +## Pre-Requisites + +- Visual Studio (15.7+) +- F# (4.5+) +- FsCheck +- xUnit +- .Net Standard 2.0 +- .Net (4.7+) +- Console.Waterworks + +## Death Socket (Library/NuGet Package) + +This is a .Net Standard 2.0 library. I wrote it in F# and it focues on .Net 4.7+, for now. At the moment, you can add it to your project via MyGet. To do this, copy the following command into you Package-Manager console, + +```powershell +// Make sure you change the version number to match the one you want. + +PM> Install-Package DeathSocket -Version 0.4.0-alpha1 _Source https://www.myget.org/F/the-immutable-null/api/v3/index.json +``` + +When Death mature, the plan is to publish it to nuget.org. MyGet will then act as the experimentation feed and NuGet as the stable one. + +For more information, please visit the project's [wiki](https://github.com/CraigOates/Death-Socket/wiki). + +![death-socket-overview](.github/Images/death-socket-overview.png) + +## Death Socket CLI + +This project is an F# console program, built with .Net 4.7. It uses Console.Waterworks to parse the users input/commands. I recommend you read the [Console.Waterworks wiki](https://github.com/CraigOates/Console.Waterworks/wiki) if you want to extend this project. It would, also, help you get a better understanding of how the console program works. + +If you want to use the program, I recommend the `add-default` command. All you need to do is specify the path of the image you want to add the grid to and its new save location. + +For further information, please visit the project's [wiki](https://github.com/CraigOates/Death-Socket/wiki). + +![death-socket-demo](.github/Images/death-socket-demo.gif) + +If you have no need for the source code, just the functionality, then use this on its own. You can download the console program in the [Releases](https://github.com/CraigOates/Death-Socket/releases) section as a stand-alone program. It is a full .Net console program so you will need to use [Mono](https://www.mono-project.com/) if you are using Linux or MacOS. + +## Test Centre + +This project holds all the tests for this repository. It uses a combination of unit tests ([xUnit](https://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 passing and failing tests with ease. + +![test-explorer](.github/Images/test-explorer.jpg) + +## How to Contribute + +If you want to contribute to the project, thank you first of all and, here are some useful links for you to get started. + +- [Contributions Page](https://github.com/CraigOates/Death-Socket/blob/master/CONTRIBUTING.md) +- [Issues](https://github.com/CraigOates/Death-Socket/issues) +- [Bug Report Template](https://github.com/CraigOates/Death-Socket/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) +- [Feature Requests Template](https://github.com/CraigOates/Death-Socket/blob/master/.github/ISSUE_TEMPLATE/feature_request.md) +- [Pull Requests Template](https://github.com/CraigOates/Death-Socket/blob/master/PULL_REQUEST_TEMPLATE.md) +- [Custom Template](https://github.com/CraigOates/Death-Socket/blob/master/.github/ISSUE_TEMPLATE/custom.md) + +## Code of Conduct + +Please visit the Code of Conduct page for Death Socket at, + +- [Code of Conduct Page](https://github.com/CraigOates/Death-Socket/blob/master/CODE_OF_CONDUCT.md) +- [MIT License](https://github.com/CraigOates/Death-Socket/blob/master/LICENSE) + +## About the Creator + +Hi, my name is Craig and I am the creator of Death Socket. Thank you checking it out and I hope you find it useful. + +- Email: [craig@craigoates.net](mailto:craig@craigoates.net) +- Web: [craigoates.net](http://www.craigoates.net) +- Project: [craigoates.net/software/project/TO-BE-DETERMINED](http://www.craigoates.net/software) \ No newline at end of file