Update README.md

README.md

@@ -1,22 +1,19 @@
 # AnkiTUM
 
 ## Overview
-AnkiTUM is a collaborative repository for computer science students at the Technical University of Munich to create and share flashcards for various CS modules. The flashcards are generated from markdown files, making it easy to contribute and maintain the content.
+AnkiTUM is a collaborative repository for computer science students at the Technical University of Munich to create and share flashcards for various CS modules. The flashcards are generated from yaml files, making it easy to contribute and maintain the content.
 
-Please note that AnkiTUM is in its early stages.
+Please note that AnkiTUM is still in developement. You can help contribute to the parser here: https://github.com/hmelder/AnkiTUM-Runtime.
+
+If you have any suggestions or bugs to report, you can create an issue. Please submit bug reports regarding the parser to the "runtime" repository.
 
 ### Downloading
 Prebuilt flashcard packages (apkg files) are available on my HTTP [mirror](https://mirror.hugomelder.com/anki-decks/), and are updated automatically.
 
-### Installation
 To install the prebuilt flashcard packages:
 
-1. Navigate to the "Actions" tab of this GitHub repository.
-2. Click on the latest successful workflow run.
-3. Scroll down to the "Artifacts" section.
-4. Download the artifact and unpack it. You will find compressed archives of all available modules
-5. Extract the `.apkg` files from the `.zip` file.
-6. Import the `.apkg` file into your Anki application.
+1. Extract the `.apkg` files from the `.zip` file.
+2. Import the `.apkg` file into your Anki application.
 
 ### Updating Flashcards
 When new flashcards are added or existing ones are updated, simply download the
@@ -25,19 +22,30 @@ efficiently, meaning your progress with the cards, including study stats and
 scheduling, will not be lost when you update a deck with a newly downloaded
 package.
 
-## Generating Flashcards Locally
-To generate flashcards on your local machine, you need to have Python installed. Follow these steps:
 
-1. Clone the AnkiTUM repository.
-2. Navigate to the cloned directory.
-3. Create a virtual environment: `python -m venv ankitum-env`
-4. Activate the virtual environment:
-   - On macOS and Linux: `source ankitum-env/bin/activate`
-5. Install the converter (Make sure that you are still in the venv):
-   - `git clone https://github.com/hmelder/AnkiTUM-Runtime`
-   - `pip3 install -r AnkiTUM-Runtime/requirements.txt`
-   - `pip3 install ./AnkiTUM-Runtime`
-6. Run `sh build.sh`. This will create `build/` with all the resulting decks
+## Contributing
+
+### Guidelines
+We welcome contributions from TUM students to enhance and expand the AnkiTUM
+flashcard collection. To contribute, follow these guidelines:
+
+0. **Fork this Repository:** In order to contribute you need to create a fork of this repository
+
+1. **Create Your Flashcards:** Add or edit yaml files following the specified format for decks.
+2. **Test Locally:** Generate the flashcards locally using the provided instructions to ensure they are formatted correctly.
+3. **Commit Your Changes:** Once you've tested your flashcards, commit the changes to your forked repository.
+4. **Submit a Pull Request (PR):** Create a PR against the main AnkiTUM repository. Include a short description of your changes and any other relevant information.
+5. **Review:** Wait for a repository maintainer to review your PR. Be responsive to any feedback or required changes.
+
+### Best Practices
+- Ensure your flashcards are accurate and relevant to the CS modules.
+- Check for duplicates to avoid redundant content.
+- Keep your yaml files organized by module and topic.
+
+By following these guidelines, you'll help maintain the quality and usefulness
+of the AnkiTUM flashcard repository for all students. Your contributions are
+greatly appreciated!
+
 
 ## Flashcard Format
 We use [YAML](https://yaml.org/) to write decks which are then converted to Anki decks using [AnkiTUM-Runtime](https://github.com/hmelder/AnkiTUM-Runtime).
@@ -50,7 +58,7 @@ types do not have a back. They contain "clozes" which are words or phrases
 inside a sentence that are blacked out and get revealed when the user turns the
 card around.
 
-Our converter supports plaintext, markdown, and latex.
+Our converter supports plaintext, markdown, and latex. You can also include images in your flashcards.
 
 Here is an example of a basic card with markdown:
 
@@ -79,28 +87,25 @@ cards:
   back: World!
 ```
 
-## Releases
-
-Modules are released when they reach a stable iteration, reflecting the latest
-contributions at that time.
+Tip: the |+ operator easily lets you write out long strings in yaml without having to surround them with quotes. 
 
-## Contributing
 
-### Guidelines
-We welcome contributions from TUM students to enhance and expand the AnkiTUM
-flashcard collection. To contribute, follow these guidelines:
+## Generating Flashcards Locally
+Our runtume script will generate anki decks from yaml files.
+To generate flashcards on your local machine, you need to have Python installed. Follow these steps:
 
-1. **Create Your Flashcards:** Add or edit markdown files following the specified format for decks.
-2. **Test Locally:** Generate the flashcards locally using the provided instructions to ensure they are formatted correctly.
-3. **Commit Your Changes:** Once you've tested your flashcards, commit the changes to your forked repository.
-4. **Submit a Pull Request (PR):** Create a PR against the main AnkiTUM repository. Include a clear description of your changes and any other relevant information.
-5. **Review:** Wait for a repository maintainer to review your PR. Be responsive to any feedback or required changes.
+1. Clone the AnkiTUM repository.
+2. Navigate to the cloned directory.
+3. Create a virtual environment: `python -m venv ankitum-env`
+4. Activate the virtual environment:
+   - On macOS and Linux: `source ankitum-env/bin/activate`
+5. Install the converter (Make sure that you are still in the venv):
+   - `git clone https://github.com/hmelder/AnkiTUM-Runtime`
+   - `pip3 install -r AnkiTUM-Runtime/requirements.txt`
+   - `pip3 install ./AnkiTUM-Runtime`
+6. Run `sh build.sh`. This will create `build/` with all the resulting decks
 
-### Best Practices
-- Ensure your flashcards are accurate and relevant to the CS modules.
-- Check for duplicates to avoid redundant content.
-- Keep your markdown files organized by module and topic.
+## Releases
 
-By following these guidelines, you'll help maintain the quality and usefulness
-of the AnkiTUM flashcard repository for all students. Your contributions are
-greatly appreciated!
+Modules are released when they reach a stable iteration, reflecting the latest
+contributions at that time.