tuansydau/tab2xml

Turns plain-text guitar tablature into MusicXML files.

TablatureConverter 🎶

---

Table of Contents

• Description
• System Requirements
• User Manual
• Requirements Document
• Testing Document
• Design Document
• Contributors
• License

---

Description

Tablature notation is a way of writing down an instrument’s parts in an accessible manner. The tablature in the context of this project will refer to guitar tablature. Although tablature is widely used for its ease of use, most tabs exist in a text format, and there does not exist an easy way to turn guitar tab text into a more featured digital file format.

The software product will consist of a desktop application. Upon the upload of a tablature in *.txt form, the system will convert the tab to a MusicXML file format.

Inputting .txt Tablature

Output .xml Tablature

XML Output on Musescore

Technologies

• Java - Programming Language
• JavaFx - Client Application Platform for Desktop
• JAXB - XML Binding

---

System Requirements

TablatureConverter requires the the following to run:

• IntelliJ or Eclipse
• Java version 11 or newer

---

User Manual

This user manual includes installation instructions, "how to get started", and common usage scenarios.

---

Requirements Document

This requirements document describes the needs of the customer. All required features are described in detail. Use cases and user stories are provided.

---

Testing Document

The testing document describes the test cases, the way they were derived, and the way they were implemented.

---

Design Document

The design document describes the high level organization of the system as well as individual components. Informative class and sequence diagrams are provided and Maintenance scenarios are discussed.

---

Contributors

• https://github.com/jamesmqle
• https://github.com/tuansydau
• https://github.com/tizreal
• https://github.com/amin45mh

---

Contact Us

Tuan Dau - [email protected]

James Le - [email protected]

Temi Odunfa- [email protected]

Amin Mohammadi- [email protected]

---

License

MIT License

Copyright (c) 2018 Othneil Drew

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.