From 4c054008f7adc64a78d73bd179b77dc5625ba4c0 Mon Sep 17 00:00:00 2001 From: Simon Diesenreiter Date: Mon, 2 Dec 2024 12:20:09 +0100 Subject: [PATCH] ci: initial commit, ref A24-7 --- README.md | 38 ++------------------------------------ 1 file changed, 2 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 76882e0..e3a219a 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,7 @@ - -# Dotnet Project Template - -A low dependency and really simple to start project template for Python Projects. - -See also -- [Dotnet-Executable-Template](https://git.disi.dev/Templates/Dotnet_Executable/) for a library template. - -### HOW TO USE THIS TEMPLATE - -1. Create a new repository from this template and choose a name for your project - (e.g. `my_awesome_project` - recommendation is to use underscores separation for repo names.) -2. Wait until the first run of CI finishes (Gitea Actions will process the template and commit to your new repo) -3. Read the file [CONTRIBUTING.md](CONTRIBUTING.md) -4. Then clone your new project and happy coding! - -> **NOTE**: **WAIT** until first CI run on gitea actions before cloning your new project. - -### What is included on this template? - -- ๐Ÿ–ผ๏ธ Templates for starting multiple application types: - **Run `make init` after cloning to generate a new project based on a template.** -- ๐Ÿค– A [Makefile](Makefile) with the most useful commands to install, test, lint, format and release your project. -- ๐Ÿ“ƒ Documentation structure using [mkdocs](http://www.mkdocs.org) -- ๐Ÿ’ฌ Auto generation of change log using **gitchangelog** to keep a HISTORY.md file automatically based on your commit history on every release. -- ๐Ÿ‹ A simple [Containerfile](Containerfile) to build a container image for your project. - `Containerfile` is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file. -- ๐Ÿงช Testing structure -- โœ… Code linting -- ๐ŸŽฏ Entry points to execute your program with basic CLI argument parsing. -- ๐Ÿ”„ Continuous integration using [Gitea Actions](.gitea/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments. - - - ---- # project_name -project_description +This project provides inputs for Advent of Code puzzles. +Be careful: these inputs are tailored to a specific user account and might not be valid for your examples! ## Usage