README.md

Common language-agnostic documents for a consistent developer experience

This is a template containing developer experience documentation: README, a code of conduct, a contributor's guide, and a license. This is a quick way to ensure an open source project has enough information for those interested in it.

Quickstart

Install .NET Core then install this template:

dotnet new -i Syncromatics.Engineering.DX.Common

Use this template in your project's root directory:

dotnet new syncdx-common --projectName 'My Project' --githubOwner 'username' --githubRepo 'reponame' --contactEmail '[email protected]'

See what other parameters are supported in this template:

dotnet new syncdx-common -h

Building

1. Ensure you have installed .NET Core
2. Run dotnet pack Syncromatics.Engineering.DX.Common.csproj in the root directory

This will build a Syncromatics.Engineering.DX.Common.0.0.0.nupkg file that you can test locally by installing with the dotnet new command:

dotnet new -i ./bin/Debug/Syncromatics.Engineering.DX.Common.0.0.0.nupkg

Code of Conduct

We are committed to fostering an open and welcoming environment. Please read our code of conduct before participating in or contributing to this project.

Contributing

We welcome contributions and collaboration on this project. Please read our contributor's guide to understand how best to work with us.

License and Authors

GMV Syncromatics Engineering

This software is made available by GMV Syncromatics Engineering under the MIT license.