https://github.com/alexshem247/note-and-flashcard-maker

Allows users to create notes, view notes, learn notes and view performance in a certain course or subject.
https://github.com/alexshem247/note-and-flashcard-maker

matplotlib pyqt5 python sqlite3

Last synced: about 2 months ago
JSON representation

Allows users to create notes, view notes, learn notes and view performance in a certain course or subject.

• Host: GitHub
• URL: https://github.com/alexshem247/note-and-flashcard-maker
• Owner: AlexShem247
• License: mit
• Created: 2021-09-18T18:07:48.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T14:07:04.000Z (5 months ago)
• Last Synced: 2024-08-21T15:59:03.121Z (5 months ago)
• Topics: matplotlib, pyqt5, python, sqlite3
• Language: Python
• Homepage:
• Size: 987 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Smart Retain by Alexander Shemaly

Smart Retain is an innovative application designed to help users manage their notes, enhance their learning experience, and track their performance in various courses or subjects. Smart Retain combines note-taking, machine learning, and performance analytics to create an integrated learning tool.

*Application written in Python 3.9 using the PyQt5 GUI toolkit. Made in 2022.*

## Table of Contents

- [About the Program](#about-the-program)

- [Features](#features)

- [Installation](#installation)

- [How to Use](#how-to-use)

  - [Create Notes](#create-notes)

  - [Learn Notes](#learn-notes)

  - [Home Window](#home-window)

- [License](#license)

## About the Program

Smart Retain is a desktop application that facilitates efficient note-taking and learning. It leverages advanced features such as a built-in PDF viewer, snippet capture, and machine learning algorithms to optimize the user's study experience. The program is available for PC and is written in Python 3.9 using the PyQt GUI toolkit.

## Features

- **Create Notes:** Detailed input options to label notes with question, answer, keywords, topic, subtopic, and note type.

- **PDF Viewer:** Read from textbooks or PDFs while making notes, eliminating the need to switch windows.

- **Snippet Capture:** Take pictures from PDFs, add them directly to notes, and annotate them.

- **Learn Notes:** Machine learning-based suggestions for which notes to study, with customizable focus on topics and subtopics.

- **Home Window:** Visual charts and graphs to track progress and identify areas for improvement.

## Installation

To install Smart Retain on your Windows, download the ZIP from the [Releases](https://github.com/AlexShem247/note-and-flashcard-maker/releases/) page and run the executable.

## How to Use

### Create Notes

1. **Open the Create Notes Window:**

   - Input detailed information for each note, including questions, answers, keywords, topics, subtopics, and note type.

   - Use the PDF viewer feature to reference textbooks or PDFs while taking notes.

   - Capture snippets from PDFs and add images to your notes. Annotate these images as needed.

### Learn Notes

1. **Access the Learn Notes Window:**

   - The application will use machine learning to suggest which notes to study based on your saved data.

   - Focus on specific topics, subtopics, or starred notes.

   - Engage with interactive tasks such as fill-in-the-blanks or complete definitions, tailored to your learning needs.

### Home Window

1. **View Your Progress:**

   - The Home Window organizes your saved data into visual charts and graphs.

   - Analyze your progress in various courses and identify areas for improvement.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Happy learning with Smart Retain!