From b15a19e2dcd59ed842a6f6351fb1573e346f87eb Mon Sep 17 00:00:00 2001 From: zkldi Date: Wed, 16 Jun 2021 12:21:22 +0100 Subject: [PATCH 1/2] update README.md --- docs/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index a33edad2e..d135d62e2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ -# MKDocs-Template +# Tachi-Docs -My preferred defaults and a template for MKDocs, which is also my preferred engine for writing documentation. +This is the documentation for Tachi. # Setup @@ -10,3 +10,7 @@ If you're in a horribly hellish python environment like me (Sorry Sera, you know - `git clone ` - `pip install mkdocs-material` - `mkdocs serve` + +# Contributing + +Fork the repository and PR your changes to `develop`. From bd80d3af854064cb692dbfb32edd48b632ac0d32 Mon Sep 17 00:00:00 2001 From: zkldi Date: Wed, 16 Jun 2021 12:21:49 +0100 Subject: [PATCH 2/2] add cd instruction --- docs/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/README.md b/docs/README.md index d135d62e2..bc1975487 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,7 @@ If you're in a horribly hellish python environment like me (Sorry Sera, you know - `pip install mkdocs` - `git clone ` - `pip install mkdocs-material` +- `cd repo` - `mkdocs serve` # Contributing