Craig Oates
72d7fc40aa
|
5 years ago | |
---|---|---|
.github | 5 years ago | |
DeathSocket | 5 years ago | |
DeathSocketCLI | 5 years ago | |
TestCentre | 5 years ago | |
.gitignore | 6 years ago | |
CODE_OF_CONDUCT.md | 6 years ago | |
CONTRIBUTING.md | 6 years ago | |
DeathSocket.sln | 6 years ago | |
LICENSE | 6 years ago | |
PULL_REQUEST_TEMPLATE.md | 6 years ago | |
README.md | 6 years ago |
README.md
Summary
Death Socket consists of 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.
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,
// 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.
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 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.
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 section as a stand-alone program. It is a full .Net console program so you will need to use Mono 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) and property tests (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.
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
- Issues
- Bug Report Template
- Feature Requests Template
- Pull Requests Template
- Custom Template
Code of Conduct
Please visit the Code of Conduct page for Death Socket at,
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
- Web: craigoates.net
- Project: craigoates.net/software/project/TO-BE-DETERMINED