Skip to content

Commit 7519f70

Browse files
authored
Revise README structure and content
Updated README formatting and added documentation links.
1 parent 98018c2 commit 7519f70

1 file changed

Lines changed: 22 additions & 17 deletions

File tree

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1-
<div align="center">
2-
<img src="assets/logo.png" alt="Roneat Studio Pro Logo" width="200" />
3-
4-
<h1>Roneat Studio Pro ᨠ</h1>
5-
6-
<p>
7-
<b>A professional suite designed for transcribing, editing, and exporting scores for the Roneat (the traditional Cambodian xylophone).</b>
8-
</p>
9-
<p>
10-
It combines modern AI audio analysis with a specialized score editor to bridge the gap between traditional performance and digital notation.
11-
</p>
12-
</div>
13-
14-
<br />
1+
# ![Roneat Studio Pro Logo](assets/logo.png)
2+
3+
# Roneat Studio Pro ᨠ
4+
5+
**A professional suite designed for transcribing, editing, and exporting scores for the Roneat (the traditional Cambodian xylophone).**
6+
7+
It combines modern AI audio analysis with a specialized score editor to bridge the gap between traditional performance and digital notation.
8+
9+
📚 **[Read the Official Documentation](https://roneat-studio-pro.gitbook.io/roneat-studio-pro-docs)**
10+
11+
---
12+
13+
## 📚 Documentation
14+
15+
For complete instructions on how to use the software, including interface overview, AI audio transcription, and exporting guides, please refer to our official documentation:
16+
17+
👉 **[Roneat Studio Pro Documentation](https://roneat-studio-pro.gitbook.io/roneat-studio-pro-docs)**
18+
19+
---
1520

1621
## ✨ Key Features
1722

@@ -23,7 +28,7 @@
2328
- **📂 Project Management**: Save and load your work using the `.roneat` project format.
2429
- **🖱️ Drag & Drop**: Quickly import audio files or open projects by dragging them directly into the app.
2530

26-
<br />
31+
---
2732

2833
## 🚀 Getting Started (For Developers & Source Code Users)
2934

@@ -75,7 +80,7 @@ Simply run the main entry point:
7580
python main.py
7681
```
7782

78-
<br />
83+
---
7984

8085
## 🛠️ Building the Executable
8186

@@ -92,7 +97,7 @@ python build.py
9297
```
9398
*The executable will be generated in the `dist/` folder.*
9499

95-
<br />
100+
---
96101

97102
## 📝 License
98103

0 commit comments

Comments
 (0)