From 6bad5f53bf9de7dbfe4b4dae6761f4c1b12cb8f0 Mon Sep 17 00:00:00 2001 From: Craig Oates Date: Mon, 1 Jul 2019 21:31:22 +0100 Subject: [PATCH] change GitHub references to GitLab. --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ------------ .github/ISSUE_TEMPLATE/custom.md | 7 --- .github/ISSUE_TEMPLATE/feature_request.md | 17 ------ .../Images/death-socket-demo.gif | Bin .../Images/death-socket-logo.png | Bin .../Images/death-socket-output-sample.jpg | Bin .../Images/death-socket-overview.png | Bin {.github => .gitlab}/Images/repo-banner.png | Bin {.github => .gitlab}/Images/test-explorer.jpg | Bin CODE_OF_CONDUCT.md | 46 --------------- CONTRIBUTING.md | 1 - DeathSocketCLI/DeathSocketCLI.fsproj | 1 - DeathSocketCLI/WaterWorksIcon.ico | Bin 16958 -> 0 bytes PULL_REQUEST_TEMPLATE.md | 1 - README.md | 54 +++++++----------- 15 files changed, 20 insertions(+), 142 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/custom.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md rename {.github => .gitlab}/Images/death-socket-demo.gif (100%) rename {.github => .gitlab}/Images/death-socket-logo.png (100%) rename {.github => .gitlab}/Images/death-socket-output-sample.jpg (100%) rename {.github => .gitlab}/Images/death-socket-overview.png (100%) rename {.github => .gitlab}/Images/repo-banner.png (100%) rename {.github => .gitlab}/Images/test-explorer.jpg (100%) delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 DeathSocketCLI/WaterWorksIcon.ico delete mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index b735373..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 99bb9a0..0000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. - ---- - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 066b2d9..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/Images/death-socket-demo.gif b/.gitlab/Images/death-socket-demo.gif similarity index 100% rename from .github/Images/death-socket-demo.gif rename to .gitlab/Images/death-socket-demo.gif diff --git a/.github/Images/death-socket-logo.png b/.gitlab/Images/death-socket-logo.png similarity index 100% rename from .github/Images/death-socket-logo.png rename to .gitlab/Images/death-socket-logo.png diff --git a/.github/Images/death-socket-output-sample.jpg b/.gitlab/Images/death-socket-output-sample.jpg similarity index 100% rename from .github/Images/death-socket-output-sample.jpg rename to .gitlab/Images/death-socket-output-sample.jpg diff --git a/.github/Images/death-socket-overview.png b/.gitlab/Images/death-socket-overview.png similarity index 100% rename from .github/Images/death-socket-overview.png rename to .gitlab/Images/death-socket-overview.png diff --git a/.github/Images/repo-banner.png b/.gitlab/Images/repo-banner.png similarity index 100% rename from .github/Images/repo-banner.png rename to .gitlab/Images/repo-banner.png diff --git a/.github/Images/test-explorer.jpg b/.gitlab/Images/test-explorer.jpg similarity index 100% rename from .github/Images/test-explorer.jpg rename to .gitlab/Images/test-explorer.jpg diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index dac3cae..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -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/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index eb6164a..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -Template under construction... diff --git a/DeathSocketCLI/DeathSocketCLI.fsproj b/DeathSocketCLI/DeathSocketCLI.fsproj index 66fbf18..27d4d1f 100644 --- a/DeathSocketCLI/DeathSocketCLI.fsproj +++ b/DeathSocketCLI/DeathSocketCLI.fsproj @@ -56,7 +56,6 @@ - diff --git a/DeathSocketCLI/WaterWorksIcon.ico b/DeathSocketCLI/WaterWorksIcon.ico deleted file mode 100644 index ca3bed5982b1455004bcf57cfeb5ee0704c46aed..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 16958 zcmeHOJ#W-N5cMfV%A}&@%9QyBiD+rk(MIA2ke=o`$`t&7s}T}ukPy{Hf`;lE8bom^ zkdSDC1cZE$IP+`|^6l;Hc+X?Ucez2Ext-med2eQIbG9!@dh~C1H=)1%Wb09qJV=sc ziyE1d0X5h&p|KcA({z*C0ksjeMU*1~y-#g(4&DP=ce;qAJ($5`uSyPR-Zr(d$Hy|5 zhM^o3+?S>1QoX!62ywqY{hD5kU#91yXX)A7C+VM8JDqKR-#^W80`JZ5?@|s1?mnQ2 zGkgB#@>hEP@p)&tYIQh!^Ekcw@>#RWCmYASD*m)N;HHVyUemB(9Ot$wVs#D#H%+SGww{CYz}4iP2+gu4Vvu6Mnp=!N zT=!kUwK&FyHrMs<_O8A8EYP2sCQW`_df7wG7o0UHRb;g;j^Xh zMc|)(XQ4fBb>PCt;tGZnItz z2G_pgZ*w0Ewbf)*fBAT|&W%hVc~JjPs}*`lyr=*x^pEAuDx!Y@_N^|+b_>;`m-Bb z>RaNFVzAvZmgb9NYFhIXGp@zz;&=={ZEhF&g)recw8klBJQS;oV|Zp4!%v&rMUEj% zR?q%8FQHgn8*AcObk{hB@K}EDS)}@B?;RPv`@+0ghw^>bW7zMw?~i8yjMrLg91%aJ zN&aGd;Qm$c z;bpteFOE%|o9YUDv~`^Oc)+HKZ=D5qjtgJD7;V`YhopTtq`C9jeKFdyX_$RD?tA_3 z)A4`T=O^F(v$BDkCYH|{t#DiU0XL7FmTgVEb7Y0Tt{>rj=OT*6$qF!ECkG_iiO|KPY|!GNI2?(&l^cRvaZi+4akLud*Q9FZl0GkuN&9 z_t@s|U?lu??6`mEzEfJzI|O$YvJDISjKc8%KRADOJs+qwaAN;@j(6rZp${{^i6z^R z+Oi9-cmIF;#`R}SV}m75K#+SW2lx%}Xvy+0BtA2Ho;mw8%|{*%sg0>Eq5wDW_kH|e zyU7Q3&U5|nXRbF+a=m_>>$O7n26?}itJUAGWMEJLDRl2R@Apn}y;jt9y{PjB*Zmf{ C+L_V- diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index eb6164a..0000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1 +0,0 @@ -Template under construction... diff --git a/README.md b/README.md index 4594cf8..5bcc18f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -![repo-banner](.github/Images/repo-banner.png) +![repo-banner](.gitlab/Images/repo-banner.png) ## 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. -![death-socket-overview](.github/Images/death-socket-output-sample.jpg) +![death-socket-overview](.gitlab/Images/death-socket-output-sample.jpg) ## Pre-Requisites @@ -18,55 +18,41 @@ Death Socket consists of three projects. They are a .Net Standard 2.0 library, a ## 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, +This is a .Net Standard 2.0 library. I wrote it in F# and it focuses on .Net 4.7+. To add it to your project use the following command in your Package-Manager console (assuming Visual Studio), ```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 +Install-Package DeathSocket -Version 1.0.0.1 ``` -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. +If you are using the .Net CLI, use the following, -For more information, please visit the project's [wiki](https://github.com/CraigOates/Death-Socket/wiki). +```powershell +// Again, make sure you change the version number to the one you want. +dotnet add package DeathSocket --version 1.0.0.1 +``` -![death-socket-overview](.github/Images/death-socket-overview.png) +For more information, please visit the project's [wiki](https://gitlab.com/CraigOates/Death-Socket/wiki). + +![death-socket-overview](.gitlab/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. +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://gitlab.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. +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). +For further information, please visit the project's [wiki](https://gitlab.com/CraigOates/Death-Socket/wiki). -![death-socket-demo](.github/Images/death-socket-demo.gif) +![death-socket-demo](.gitlab/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. +If you have no need for the source code, just the functionality, then use this on its own. 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, +This project holds all the tests for this repository. It uses a combination of unit tests ([xUnit](https://xunit.gitlab.io/)) and property tests ([FsCheck](https://fscheck.gitlab.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. -- [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) +![test-explorer](.gitlab/Images/test-explorer.jpg) ## About the Creator @@ -74,4 +60,4 @@ Hi, my name is Craig and I am the creator of Death Socket. Thank you checking it - 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) +- Project: [craigoates.net/software/project/13](https://www.craigoates.net/Software/project/13)