spectrostaff is an application for visualizing music
this guide will help you set up your development environment for the spectrostaff
project
ensure you have the following installed on your machine:
- Git
- Make
- Poetry
- Python 3.11
-
clone the repository: use the following command to clone the
develop
branch of thespectrostaff
repository:git clone -b develop https://github.com/kiefer138/spectrostaff
-
navigate to the project directory:
cd spectrostaff
-
install the project in development mode: this will install all the dependencies you need for development
make install
build the documentation:
```bash
make docs
```
view the documentation:
```bash
make view-docs
```
run the tests:
```bash
make test
```
build the project using the following command:
```bash
make build
```
clean the project using the following command:
```bash
make clean
```
display help information with the following command:
```bash
make help
```
- Tyler Evans
this project is licensed under the MIT License