From fc6837215b9753f96f013562419e70c8ed87e022 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Fri, 4 Jun 2021 14:13:32 +0200 Subject: [PATCH] Added index to markdown --- readme.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index b202c87..d713883 100644 --- a/readme.md +++ b/readme.md @@ -24,6 +24,20 @@ Hazelnupp args; args.SetCrashOnFail(false); ``` +## Index +1. [Importing into a project](#importing-into-a-project) +1. [What's the concept?](#whats-the-concept) +1. [Minimal working example](#minimal-working-example) +1. [Abbreviations](#abbreviations) +1. [Constraints](#constraints) +1. [Minimal working example](#minimal-working-example) +1. [Automatic parameter documentation](#automatic-parameter-documentation) +1. [More examples?](#more-examples) +1. [What is not supported?](#what-is-not-supported) +1. [Further notes](#further-notes) +1. [Contributing](#contributing) +1. [LICENSE](#license) + ## Importing into a project > How do i actually import this into my existing project? @@ -316,7 +330,7 @@ Feel free to submit a PR if you think you improved it in any way :) ## Contributing If you want to contribute, feel free to fork the repository, and submit a pull request. Bugfixes and tests are almost certain to be accepted, features should agreed upon and come with tests. -Just create an issue with the tag `feature request`. Don't forget to update the UML `Hazelnupp.vpp` aswell! The (free) modelling software used is [Visual Paradigm](https://www.visual-paradigm.com). +Just create an issue with the tag `feature request`. Don't forget to update the UML (`Hazelnupp.vpp`)! The (free) modelling software used is [Visual Paradigm](https://www.visual-paradigm.com). Any code added must match the existing style! * Objects begin with a lowercase initial