Skip to content

Commit

Permalink
Update README.md with installation and usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
andreamust committed Mar 23, 2024
1 parent 5068d05 commit bebf25f
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The library has the following dependencies:
- [music21](http://web.mit.edu/music21/): as an extension of the library itself;
- [Lark](https://github.com/lark-parser/lark): for parsing the chords in Harte.

## Installation
## 🛠️ Installation

The library is available on PyPi. To install, simply execute the following command:

Expand All @@ -30,9 +30,9 @@ The Harte Library offers several core functionalities:
- **Interpretability**: Easily interpret chords notated in Harte format, including the unrolling of shorthand representations.
- **Simplification**: Streamline and standardize chords in Harte notation using the prettify_harte functionality.

## Usage
## 🚀 Usage

### Interval Module
### 🎵 Interval Module

The Harte Library extends the Interval Module of music21 to ensure interoperability between intervals expressed according to Harte notation and the interval class of music21.

Expand All @@ -47,7 +47,7 @@ int_name = interval.name
int_is_consonant = interval.isConsonant()
```

### Chord Module
### 🎸 Chord Module

The primary functionality of the Harte Library extends the Chord Module of music21.

Expand Down Expand Up @@ -82,10 +82,11 @@ chord = Harte('D:(b3,5,7,9)')
pretty_harte = chord.prettify() # D:minmaj7(9)
```

## Contributing
## 🤝 Contributing

We welcome contributions from the community to enhance the Harte Library. Whether you want to report a bug, suggest a new feature, or contribute code, your help is greatly appreciated!

## Reporting Issues
## 🐞 Reporting Issues

If you encounter any bugs, have feature requests, or have suggestions for improvements, please open an [issue](https://github.com/andreamust/harte-library/issues) with detailed information about the problem or suggestion.

Expand Down

0 comments on commit bebf25f

Please sign in to comment.