Skip to content

Commit

Permalink
doc: Added table of contents to README
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolasperez19 authored Oct 30, 2024
1 parent 781e2d1 commit 6fe7423
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,19 @@
<p align="left">Designed for audio engineers and researchers, this tool offers an intuitive interface for precise microphone placement, enabling users to simulate and optimize array setups for various acoustic applications.</p>
<a href="https://github.com/nicolasperez19/mic-master-flex/"><img src="https://img.shields.io/github/stars/nicolasperez19/mic-master-flex?style=for-the-badge&logo=github&logoColor=white" alt="Github Stars"></a>
<a href="https://buymeacoffee.com/nico_perez"><img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-%23FFDD00.svg?&style=for-the-badge&logo=buy-me-a-coffee&logoColor=black"></a>

</div>

# Table of Contents

1. [Demo](#demo)
2. [Project motivation](#project-motivation)
3. [Prerequisites](#prerequisites)
4. [Installation](#installation)
5. [Running the project locally](#running-the-project-locally)
6. [Building the project locally](#building-the-project-locally)
7. [Project structure](#project-structure)
8. [Citation](#citation)

## 📸 Demo
https://github.com/user-attachments/assets/419bda8b-d6a5-4f54-87b8-acef9d752226

Expand Down

0 comments on commit 6fe7423

Please sign in to comment.