From 09c293cb98a120ca1765f6f6c5761ddf6d8b0440 Mon Sep 17 00:00:00 2001 From: Yandrik Date: Wed, 20 Oct 2021 13:05:23 +0200 Subject: [PATCH] doc: added how-to-edit and contributions section to README --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7ff6858..56eb4a1 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,23 @@ It was created during the 2020/2021 lecture by Thomas Thüm. 1. Download Anki [here](https://apps.ankiweb.net/) or via package manager (e.g. `choco install -y anki` for windows using [chocolatey](https://chocolatey.org)) 2. Import the deck into Anki (`File` -> `Import` -> choose `⁙ SE.apkg` -> profit) -3. Optional: Install [Anki Image Occlusion](https://ankiweb.net/shared/info/1374772155) plugin - * In the Anki GUI, navigate to `Anki` -> `Tools` -> `Add-ons` -> `Get Add-ons` -> Enter `1374772155` as code +3. Optional: Install [Anki Image Occlusion](https://ankiweb.net/shared/info/1374772155) plugin (In the Anki GUI, navigate to `Anki` -> `Tools` -> `Add-ons` -> `Get Add-ons` -> Enter `1374772155` as code) ## How to contribute - Found an error? Want to add some cards? Contributions are always welcome. There are *two major ways to contribute*: 1. Open an issue if you found a problem 2. Open a Pull Request if you added or changed some cards. To do that: - * Make changes to cards - * Export the deck as an `.apkg` file - * Push the changed deck to a new branch in the repository (`git checkout -b fancychanges`, `git push -u origin fancychanges`) - * Open a Pull Request describing your changes + +## How to edit + +* Make changes to cards +* Export the deck as an `.apkg` file +* Push the changed deck to a new branch in the repository (`git checkout -b fancychanges`, `git push -u origin fancychanges`) +* Open a Pull Request describing your changes + +## Contributions + +* Yannik Bretschneider: Initial deck +* Maxim Switenko: Cards for Scrum and Waterfall model