Flashcard Learning App

Welcome to the Flashcard Learning App! This application is designed to help users create, manage, and study flashcards efficiently. It includes features for adding flashcards, organizing them into categories, and tracking progress through study sessions. This README provides all the necessary information to get started with the project, whether you are a developer or a non-developer.

Table of Contents

1. Features
2. Screenshots
3. Installation
4. Usage
5. Contributing
6. License

Features

• View Flashcards: Browse through all your flashcards.
• Add Flashcard: Create new flashcards with questions, answers, and categories.
• Edit Flashcards: Modify existing flashcards.
• Start Study Session: Review flashcards in a study session and track your progress.
• View Progress: See statistics on your flashcard study sessions.
• Manage Categories: Organize your flashcards into categories.
• Settings: Customize the app's appearance and behavior.

Screenshots

Here are some screenshots of the Flashcard Learning App in action:

• Main Menu
• View Flashcards
• Add Flashcard
• Edit Flashcards
• Start Study Session
• View Progress
• Manage Categories
• Settings

Installation

For Developers

1. Clone the repository:

   git clone https://github.com/yourusername/flashcard-learning-app.git
   cd flashcard-learning-app

2. Create a virtual environment and activate it:

   python -m venv venv
   source venv/bin/activate   # On Windows, use `venv\Scripts\activate`

3. Install the required dependencies:

   pip install -r requirements.txt

4. Run the application:

   python main.py

For Non-Developers

1. Download the latest release from the Releases page.
2. Unzip the downloaded file and navigate to the extracted folder.
3. Run the application by double-clicking on main.py or running it via the command line:

   python main.py

Usage

Main Menu

From the main menu, you can access all the features of the Flashcard Learning App:

• View Flashcards: Browse all flashcards.
• Add Flashcard: Create new flashcards.
• Edit Flashcards: Modify existing flashcards.
• Start Study Session: Begin a study session with selected flashcards.
• View Progress: View statistics on your study sessions.
• Manage Categories: Organize your flashcards into categories.
• Settings: Customize the application settings.
• Quit App: Exit the application.

Adding Flashcards

To add a new flashcard:

1. Click on Add Flashcard in the main menu.
2. Fill in the Question, Answer, and select a Category.
3. Click Save to add the flashcard.

Starting a Study Session

To start a study session:

1. Click on Start Study Session in the main menu.
2. Select the session length and categories.
3. Click Start Session.

During the session, you can mark flashcards as Correct or Incorrect and view your progress.

Viewing Progress

To view your study progress:

1. Click on View Progress in the main menu.
2. Browse the statistics for each flashcard.

Managing Categories

To manage categories:

1. Click on Manage Categories in the main menu.
2. Add, edit, or delete categories as needed.

Customizing Settings

To customize the application settings:

1. Click on Settings in the main menu.
2. Adjust the Theme and UI Scale as desired.
3. Click Save Settings to apply the changes.

Contributing

We welcome contributions from the community! If you would like to contribute, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine:

   git clone https://github.com/yourusername/flashcard-learning-app.git

3. Create a new branch for your feature or bugfix:

   git checkout -b feature-name

4. Make your changes and commit them:

   git commit -am 'Add new feature'

5. Push your changes to your forked repository:

   git push origin feature-name

6. Create a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

---

Thank you for using the Flashcard Learning App! We hope it helps you in your learning journey. If you have any questions or feedback, please feel free to open an issue on GitHub.