diff --git a/docs/ESLintConvention.md b/docs/ESLintConvention.md deleted file mode 100644 index 001dba56ac6f0f96234f03d0278f618826728495..0000000000000000000000000000000000000000 --- a/docs/ESLintConvention.md +++ /dev/null @@ -1,45 +0,0 @@ -## ESLint Convention - -Make the changes to the code and tests and then commit to your branch. Be sure to follow the commit message conventions. - -Commit message summaries must follow this basic format: - -``` -Tag: Message (fixes #1234) -``` - -`Tag` should not be confused with git tag. -`Message` should not be confused with git commit message. - -The `Tag` is one of the following: - -* `Fix` - for a bug fix. -* `Update` - for a backwards-compatible enhancement. -* `Breaking` - for a backwards-incompatible enhancement. -* `Docs` - changes to documentation only. -* `Build` - changes to build process only. -* `New` - implemented a new feature. -* `Upgrade` - for a dependency upgrade. - -The message summary should be a one-sentence description of the change. The issue number should be mentioned at the end. * The commit message should say "(fixes #1234)" at the end of the description if it closes out an existing issue (replace 1234 with the issue number). If the commit doesn't completely fix the issue, then use `(refs #1234)` instead of `(fixes #1234)`. - -Here are some good commit message summary examples: - -``` -Build: Update Travis to only test Node 0.10 (refs #734) -Fix: Semi rule incorrectly flagging extra semicolon (fixes #840) -Upgrade: Esprima to 1.2, switch to using Esprima comment attachment (fixes #730) -``` - -The commit message format is important because these messages are used to create a changelog for each release. The tag and issue number help to create more consistent and useful changelogs. - -Based on https://github.com/eslint/eslint.github.io/blob/master/docs/developer-guide/contributing.md#step-2-make-your-changes - -[npm-image]: https://badge.fury.io/js/conventional-changelog-eslint.svg -[npm-url]: https://npmjs.org/package/conventional-changelog-eslint -[travis-image]: https://travis-ci.org/stevemao/conventional-changelog-eslint.svg?branch=master -[travis-url]: https://travis-ci.org/stevemao/conventional-changelog-eslint -[daviddm-image]: https://david-dm.org/stevemao/conventional-changelog-eslint.svg?theme=shields.io -[daviddm-url]: https://david-dm.org/stevemao/conventional-changelog-eslint -[coveralls-image]: https://coveralls.io/repos/stevemao/conventional-changelog-eslint/badge.svg -[coveralls-url]: https://coveralls.io/r/stevemao/conventional-changelog-eslint \ No newline at end of file diff --git a/docs/home.md b/docs/home.md deleted file mode 100644 index e57a4ee9c07e6ca3f79756079043959585835658..0000000000000000000000000000000000000000 --- a/docs/home.md +++ /dev/null @@ -1,31 +0,0 @@ -## C# Template - -This template includes: - -* Automatic building using cake -* Automatic testing with NUnit -* Automatic linting with Resharper -* Automatic documentation publishing using Gitlab CI / CD and a self written script which puts the docs in the docs folder to the wiki -* Automatic releases using semantic-release ([ESLint Code Convention](ESLintConvention)), cake and Gitlab CI / CD - -## What you need to do - -Place you C# project solution file in .src/. -Make sure Create directory for solution is unticked. - - - -Delete unused docs and update this README. - -Add [NUnit](nunit) tests to your solution. - -## Building - -Build this project by running either the build.ps1 or the build<span></span>.sh script. -The project will be build and tested. - -### Links - -* [Commit convention](ESLintConvention) -* [Everything possible with markup](testdoc) -* [Adding NUnit tests](nunit) diff --git a/docs/images/add_a_package.png b/docs/images/add_a_package.png deleted file mode 100644 index e8e8ed2121edfc81d8fb2e4f3e03ed4807c66eea..0000000000000000000000000000000000000000 Binary files a/docs/images/add_a_package.png and /dev/null differ diff --git a/docs/images/add_a_reference.png b/docs/images/add_a_reference.png deleted file mode 100644 index 4ee38c9951bc5739297b78abb2c82113286f6e71..0000000000000000000000000000000000000000 Binary files a/docs/images/add_a_reference.png and /dev/null differ diff --git a/docs/images/create_class_library.png b/docs/images/create_class_library.png deleted file mode 100644 index 89a252c6e358c73fb9b7299464f851e69127285a..0000000000000000000000000000000000000000 Binary files a/docs/images/create_class_library.png and /dev/null differ diff --git a/docs/images/create_project.png b/docs/images/create_project.png deleted file mode 100644 index f7ae1a1701c9287d5f7a959bf856f55966293081..0000000000000000000000000000000000000000 Binary files a/docs/images/create_project.png and /dev/null differ diff --git a/docs/images/select_framework.png b/docs/images/select_framework.png deleted file mode 100644 index bba5b07168b73cb1005150aad92d6d925bada649..0000000000000000000000000000000000000000 Binary files a/docs/images/select_framework.png and /dev/null differ diff --git a/docs/images/select_project.png b/docs/images/select_project.png deleted file mode 100644 index 6f42cc3a18e89d6e2a26cd76de9730f39feb51bf..0000000000000000000000000000000000000000 Binary files a/docs/images/select_project.png and /dev/null differ diff --git a/docs/images/test_code.png b/docs/images/test_code.png deleted file mode 100644 index e9d9b5f88107c03fb19d4d2c6567981d25658154..0000000000000000000000000000000000000000 Binary files a/docs/images/test_code.png and /dev/null differ diff --git a/docs/nunit.md b/docs/nunit.md deleted file mode 100644 index 020e56f85510b1319edbe89e76cdd0891b5abe43..0000000000000000000000000000000000000000 --- a/docs/nunit.md +++ /dev/null @@ -1,33 +0,0 @@ -## Add NUnit Tests - -### Add Nunit test adapter -1. Choose **Tools > Extensions and Updates** -2. In the **Extensions and Updates** dialog box, expand the **Online** category and then **Visual Studio Marketplace**. Then, choose **Tools > Testing**. -2. Select the **NUnit test adapter** and then choose **Download.** -### Add Tests - -1. Create a class library project and add it to your solution. - - For convinience name it like your main project and add **.Tests** as a suffix. -  - -2. Install the plug-in. In **Solution Explorer**, select the class library project, and then choose **Manage NuGet Packages** from its right-click or context menu. - -  - -3. In the **NuGet Package Manager** window, search for and select the plug-in (NUnit), and then choose **Install**. -  - - The framework is now referenced in your project under **References**. - -4. From the class library project's **References** node, select **Add Reference**. - -  - -5. In the **Reference Manager** dialog box, select the project that contains the code you'll test. - -  - -6. Code your unit test. - -  diff --git a/docs/testdoc.md b/docs/testdoc.md deleted file mode 100644 index 938b6eb3d01ae251f10a000bda25fd4538d87d7a..0000000000000000000000000000000000000000 --- a/docs/testdoc.md +++ /dev/null @@ -1,78 +0,0 @@ -It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http://google.com) - -Sometimes you want numbered lists: - -1. One -2. Two -3. Three - -Sometimes you want bullet points: - -* Start a line with a star -* Profit! - -Alternatively, - -- Dashes work just as well -- And if you have sub points, put two spaces before the dash or star: - - Like this - - And this - -If you want to embed images, this is how you do it: - - - -# Structured documents - -Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes. - -### This is a third-tier heading - -You can use one `#` all the way up to `######` six for different heading sizes. - -If you'd like to quote someone, use the > character before the line: - -> Coffee. The finest organic suspension ever devised... I beat the Borg with it. -> - Captain Janeway - -[200~There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: `var example = true`. If you've got a longer block of code, you can indent with four spaces: - - if (isAwesome){ - return true - } - -GitHub also supports something called code fencing, which allows for multiple lines without indentation: - -``` -if (isAwesome){ - return true -} -``` - -And if you'd like to use syntax highlighting, include the language: - -```javascript -if (isAwesome){ - return true -} -``` - -GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater! - -But I have to admit, tasks lists are my favorite: - -- [x] This is a complete item -- [ ] This is an incomplete item - -When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too! - -And, of course emoji! -GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater! - -But I have to admit, tasks lists are my favorite: - - This is a complete item - This is an incomplete item -When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too! - -And, of course emoji! diff --git a/src/DfgStructureParser/DfgStructureParser.Test/DfgStructureParser.Test.csproj b/src/DfgStructureParser.Test/DfgStructureParser.Test.csproj similarity index 100% rename from src/DfgStructureParser/DfgStructureParser.Test/DfgStructureParser.Test.csproj rename to src/DfgStructureParser.Test/DfgStructureParser.Test.csproj diff --git a/src/DfgStructureParser/DfgStructureParser.Test/Properties/AssemblyInfo.cs b/src/DfgStructureParser.Test/Properties/AssemblyInfo.cs similarity index 100% rename from src/DfgStructureParser/DfgStructureParser.Test/Properties/AssemblyInfo.cs rename to src/DfgStructureParser.Test/Properties/AssemblyInfo.cs diff --git a/src/DfgStructureParser/DfgStructureParser.Test/UnitTest1.cs b/src/DfgStructureParser.Test/UnitTest1.cs similarity index 100% rename from src/DfgStructureParser/DfgStructureParser.Test/UnitTest1.cs rename to src/DfgStructureParser.Test/UnitTest1.cs diff --git a/src/DfgStructureParser/DfgStructureParser.Test/packages.config b/src/DfgStructureParser.Test/packages.config similarity index 100% rename from src/DfgStructureParser/DfgStructureParser.Test/packages.config rename to src/DfgStructureParser.Test/packages.config diff --git a/src/DfgStructureParser/DfgStructureParser.sln b/src/DfgStructureParser.sln similarity index 100% rename from src/DfgStructureParser/DfgStructureParser.sln rename to src/DfgStructureParser.sln diff --git a/src/DfgStructureParser/DfgStructureParser/App.config b/src/DfgStructureParser/App.config similarity index 100% rename from src/DfgStructureParser/DfgStructureParser/App.config rename to src/DfgStructureParser/App.config diff --git a/src/DfgStructureParser/DfgStructureParser/DfgStructureParser.csproj b/src/DfgStructureParser/DfgStructureParser.csproj similarity index 100% rename from src/DfgStructureParser/DfgStructureParser/DfgStructureParser.csproj rename to src/DfgStructureParser/DfgStructureParser.csproj diff --git a/src/DfgStructureParser/DfgStructureParser/Program.cs b/src/DfgStructureParser/Program.cs similarity index 100% rename from src/DfgStructureParser/DfgStructureParser/Program.cs rename to src/DfgStructureParser/Program.cs diff --git a/src/DfgStructureParser/DfgStructureParser/Properties/AssemblyInfo.cs b/src/DfgStructureParser/Properties/AssemblyInfo.cs similarity index 100% rename from src/DfgStructureParser/DfgStructureParser/Properties/AssemblyInfo.cs rename to src/DfgStructureParser/Properties/AssemblyInfo.cs diff --git a/src/DfgStructureParser/DfgStructureParser/packages.config b/src/DfgStructureParser/packages.config similarity index 100% rename from src/DfgStructureParser/DfgStructureParser/packages.config rename to src/DfgStructureParser/packages.config