diff --git a/README.md b/README.md index 549e949ef8799c10c136f6b8b4f26bb4c991a977..e9fa630347c9668d65a0befb3001a46beae9dbab 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,9 @@ -## C# Template +# GraphDeployer -This template includes: +This repository handles the deployment of every static graph which gets included into the CoScInE environment. -* 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](docs/ESLintConvention)), cake and Gitlab CI / CD +## Usage -## What you need to do +For every deployable graph repository, an entry is expected in the configuration path: `coscine/local/graphs/`. -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](docs/nunit.md) 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](docs/ESLintConvention.md) -* [Everything possible with markup](docs/testdoc.md) -* [Adding NUnit tests](docs/nunit.md) \ No newline at end of file +Every repository MUST include the key `coscine/local/graphs/{graphname}/repositoryurl` for specifying the url (e.g. `git.rwth-aachen.de/coscine/applicationprofiles.git`) and CAN include the key `coscine/local/graphs/{graphname}/branch` which specifies the state of the repository being imported (e.g. `master`).