Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.64 KB

README.md

File metadata and controls

80 lines (53 loc) · 3.64 KB
Raw

MusicalAid

Overview

MusicalAid is a web-based application designed to assist users in learning and identifying musical notes. It provides two key tools to help with music theory and note recognition:

  1. Note Detection Tool: This tool can identify and display musical notes from an uploaded audio clip or sound. It's useful for tuning instruments or creating a musical sheet based on the sound.

  2. Musical Knowledge Test: This tool challenges users to identify the note displayed in an image. It's a fun way to test and improve your knowledge of musical notes and their recognition.

Features

  • Note Detection Tool: Helps users detect musical notes from audio. Useful for musicians who want to tune their instruments or create sheet music based on sounds.
  • Guess the Note Game: Users are shown a picture of a musical note and need to guess its name (e.g., C#, A, F). This is a helpful game to test musical knowledge.
  • Interactive Interface: The app is easy to use, with interactive buttons and input fields.
  • Responsive Design: The tool works well across various devices, including desktops, tablets, and mobile phones.

Installation

To get started with MusicalAid, follow these steps:

Prerequisites

Make sure you have the following installed:

  • A modern web browser (e.g., Google Chrome, Firefox, Safari).
  • A code editor (e.g., Visual Studio Code, Sublime Text) to edit files.

Steps

  1. Clone the repository or download the project files to your local machine.
  2. Open the project folder in your web browser or code editor.
  3. If you're planning to use the Note Detection Tool with custom audio, ensure that your audio files are placed in the correct directory (e.g., assets/).
  4. Open the index.html file in your browser to start using the tools.

How to Use

1. Note Detection Tool

This tool listens to audio input and detects the musical note being played. To use this tool:

  • Open the Audio to Note page (original.html).
  • Upload or play an audio file with a musical note.
  • The system will detect and display the note that was played.

2. Guess the Note Game

This game displays an image of a musical note, and your goal is to guess its name.

  • The game will display an image of a note (e.g., C, A#, F#).
  • Type the name of the note in the input field (e.g., C, A#, etc.).
  • Press "Check Note" to see if your guess was correct.
  • You can press "Next Note" to move to another random note.

3. Responsive Layout

  • The app adjusts itself to fit any screen size. Whether you're using a laptop, tablet, or phone, the tools will work smoothly on all devices.

Technologies Used

  • HTML5: For creating the structure of the web pages.
  • CSS3: For styling the pages and making them responsive.
  • JavaScript: For the functionality of the musical note detection tool and the guessing game.
  • Flexbox: For layout and centering the elements.

Contributing

If you would like to contribute to MusicalAid, please feel free to fork the repository and submit a pull request. Contributions are welcome in the form of bug fixes, feature additions, or general improvements.

Steps to Contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes.
  4. Commit your changes (git commit -m "Add new feature").
  5. Push to your forked repository (git push origin feature/your-feature).
  6. Open a pull request.

License

This project is open-source and available under the MIT License.

Contact

For any questions, issues, or suggestions, feel free to reach out to the project maintainers.