diff --git a/.directory b/.directory new file mode 100644 index 0000000..5b47644 --- /dev/null +++ b/.directory @@ -0,0 +1,6 @@ +[Dolphin] +Timestamp=2019,6,17,17,19,52 +Version=4 + +[Settings] +HiddenFilesShown=true diff --git a/Home.md b/Home.md index 3036299..316320c 100644 --- a/Home.md +++ b/Home.md @@ -48,7 +48,7 @@ Before continuing, I recommend you are familiar with the following; **TODO: Write-up when paged added.** -- Introduction to Death Socket +- [Introduction to Death Socket](Introduction-to-Death-Socket) - As Source Code - As a CLI - As a NuGet diff --git a/Introduction-to-Death-Socket.md b/Introduction-to-Death-Socket.md new file mode 100644 index 0000000..eee5659 --- /dev/null +++ b/Introduction-to-Death-Socket.md @@ -0,0 +1,49 @@ +This repository is home to the Death Socket (D.S.) project. D.S. is a +basic level, it is a Visual Studio solution. Within it, there are +three smaller projects. They are a .Net Standard 2.0 library, a +console program and a testing library. The last two use the +traditional .Net Framework and I wrote all three with F#. + +The purpose of this repository is to provide a way for people to add a +grid to an image. Artists tend to call this "squaring up an image". It +does this by making the .Net Standard library available as a NuGet and +a console program. + +As an aside, the console provided is a traditional .Net console +program. It is, also, a stand-alone program so there are no +installers. + +I set the solution up with the console program referencing the .Net +Standard library; and, Test Centre (I.E. the testing library) +referencing the .Net library and console project. To help give you a +sense of what I mean, here is a diagram showing the relationships +between the three projects. + +PROJECT REF. IMAGES. + +## Why this Repository Exists + +I made this repository as the foundation for Paint Grid. At the time, +I had a grand plan to make Paint Grid run everywhere. So in an attempt +to do that, I "abstracted" the core functionality into a NuGet +package. This repository is the result of that "abstraction". + +Paint Grid is essentially the features of this project's NuGet with a +GUI. You can read more about it by using the following links; + +- [Paint Grid information on + craigoates.net](http://www.craigoates.net/Software/project/14) +- [Buy Paint Grid from the Windows + Store](https://www.microsoft.com/en-gb/p/paint-grid/9pg4l1b5sjcc?rtc=1&activetab=pivot:overviewtab) + +## Examples of Images created with Death Socket + +There is only one type of image you can create with Death Socket. The +outcome is an image with a grid overlaid on top of the original image +you fed it. With that said, you can alter how the grid looks by +altering several variables, which are; + +- the thickness and colour of the grid's lines; and +- the number of rows and columns the grid has. + +EXAMPLES OF IMAGES. (SHOW ROW AND COLUMN COUNT GUIDE.) diff --git a/_sidebar.md b/_sidebar.md index 77a2ee4..50920dd 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -3,4 +3,5 @@ ## Table of Contents - [Home](Home) +- [Introduction to Death Socket](Introduction-to-Death-Socket) - [Code Snippets for Common Tasks](https://gitlab.com/craig.oates/Death-Socket/snippets)