Yandrik/SoftwareEngineering-Anki
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

doc: added how-to-edit and contributions section to README

Browse Source
This commit is contained in:
Yandrik 2021-10-20 13:05:23 +02:00
parent 059a03fe11
commit 09c293cb98
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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 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)) (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) 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 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)
* In the Anki GUI, navigate to `Anki` -> `Tools` -> `Add-ons` -> `Get Add-ons` -> Enter `1374772155` as code
## How to contribute ## How to contribute
Found an error? Want to add some cards? Contributions are always welcome. There are *two major ways 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 1. Open an issue if you found a problem
2. Open a Pull Request if you added or changed some cards. To do that: 2. Open a Pull Request if you added or changed some cards. To do that:
## How to edit
* Make changes to cards * Make changes to cards
* Export the deck as an `.apkg` file * 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`) * 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 * Open a Pull Request describing your changes
## Contributions
* Yannik Bretschneider: Initial deck
* Maxim Switenko: Cards for Scrum and Waterfall model