/Speech-Memorization-Platform

application to guide users to memorize large sections of speeches, such as creeds or duty instructions, using delayed recall and speech to text.

Primary LanguagePython

Speech Memorization Platform

An interactive application designed to help users memorize and practice military creeds and long speeches. The app listens to your speech in real-time, transcribes it, and compares it against the original text, highlighting any discrepancies.

Imagine how lyrics from your favorite songs display on Apple Music or on karaoke apps. Now imagine using that same app to memorize and practice your speeches by gradually increasing the difficulty and removing the displayed words of the text you need to memorize.

NOT CURRENTLY WORKING This line will be removed when the app is ready for testing.

Contributing

We welcome contributions to this project. Please read our CONTRIBUTING.md file for detailed guidelines on how to contribute, including setting up SSH access, forking the repository, and submitting pull requests.

For the direction of the project, please read our ROADMAP.md file.

Join the Matrix Room to discuss the project: Matrix Room.

Features

  • Text Selection: Choose from a list of pre-established texts stored in the pre_texts directory or input your own custom text.
  • Section-wise Practice: Practice the text in full or select specific sections.
  • Real-time Transcription: Utilizes your microphone to listen and transcribe your speech.
  • Live Comparison: Compares your spoken words against the original text, highlighting errors and omissions.
  • Performance Statistics: Provides detailed feedback and accuracy stats after each practice session.
  • Session Logging: Logs each session's results for progress tracking.

Installation

Prerequisites

  • Python 3.x
  • Microphone access on your device

Steps

NOT CURRENTLY WORKING This line will be removed when the app is ready for testing.

  1. Clone the repository Don't Clone the repository if you are contributing, fork it. More information here.

    git clone git@github.com:irregularchat/Speech-Memorization-Platform.git
cd speech-memorization-platform

  2. Install dependencies

    pip install -r requirements.txt
    1. Run the application
python app.py

Usage

TBD. Detailed instructions on how to use the platform will be available once the app is ready for testing.

Roadmap

Check out the ROADMAP.md file for information on project goals and milestones. This includes our file structure, navigation, and the overall structure of the project.

Collaboration Guidelines

Please read our CONTRIBUTING.md file for detailed instructions on contributing, such as setting up your environment, forking the repository, creating branches, and submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.