🆕 ARDC Templates
❓ What is ARDC Templates?
ARDC.Commons.Templates is a collection for common files for a coding project.
Currently the following templates are available:
- README.md (A simple readme written in Markdown)
- MIT License (A LICENSE file containing the MIT License)
- GNU GPL v3 License (A LICENSE file containing the GNU GPL v3 License)
- CHANGELOG (a simple changelog written in Markdown)
⚡ Getting Started
In order to install run the following command on your shell to download the NuGet package for ARDC.Commons.Templates:
dotnet new --install ARDC.Commons.Templates
This command will download and install the templates contained in this repository.
Finally, to scaffold a file based on one of those templates, run
dotnet new TEMPLATE-NAME.
In case you wish to uninstall these templates run the following command on your shell:
dotnet new --uninstall ARDC.Commons.Templates
🔧 Building and Running
🔨 Build the Project
Since this is a template project all you need to do is run
dotnet new -i .\src\ on the root of this project and all the templates will be installed locally for you to use and test.
When you're done you can run
dotnet new --debug:reinit to remove those packages from the templates you've installed for
📦 Publishing to NuGet
dotnet pack --configuration Release -o ./pkgs/ to create a NuGet package (
.nupkg file) in the
dotnet nuget push "**/*.nupkg" --api-key yourApiKey --source https://api.nuget.org/v3/index.json to push the packages into NuGet.org.
Choose a License
License files are based on the great work done by Choose a License.
Keep a Changelog
The Changelog template contained here is based on keep a changelog and follows their suggestions almost by the letter.
🤝 Collaborate with ARDC Templates
Read-up on Microsoft's docs for creating templates for
dotnet new, available here.
Then all you need to do is fork this repository, create your template and submit a pull request 🙂.
- No dependencies.
This package is not used by any NuGet packages.
This package is not used by any popular GitHub repositories.