Skip to content

Commit

Permalink
Update package documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rbaltrusch committed Aug 18, 2022
1 parent 9817bbc commit db3e1d8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 15 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,14 @@ This tool procedurally generates music based on codified Western classical music

## Getting started

To get a copy of this repository, simply open up git bash in an empty folder and use the command:

$ git clone https://github.com/rbaltrusch/continuo

To install the continuo module and all python dependencies, run the following in your command line:

python -m pip install -e .
python -m pip install -r requirements.txt

To run the music generator, run the package from the project root folder:
To run the music generator, install it using pip, then run the package from the project root folder:

python -m pip install continuo
python -m continuo

## Example music

Example music can be found [here](example_music).
Example music can be found [here](https://github.com/rbaltrusch/continuo/blob/master/example_music).

## Parameterization

Expand Down Expand Up @@ -145,7 +137,7 @@ An example configuration file could look like this:

## Contributions

All contributions are welcome! Please read the [contribution guidelines](CONTRIBUTING.md).
All contributions are welcome! Please read the [contribution guidelines](https://github.com/rbaltrusch/continuo/blob/master/CONTRIBUTING.md).

## Python

Expand Down
8 changes: 5 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Setup file for pip install"""
from pathlib import Path

import setuptools
Expand All @@ -8,7 +8,7 @@

setuptools.setup(
name="continuo",
version="0.2.0",
version="0.2.2",
description="Procedural music generator",
long_description=project_dir.joinpath("README.md").read_text(encoding="utf-8"),
long_description_content_type="text/markdown",
Expand All @@ -22,7 +22,9 @@
package_data={"continuo": ["py.typed"]}, # for mypy
# This is a trick to avoid duplicating dependencies between both setup.py and requirements.txt.
# requirements.txt must be included in MANIFEST.in for this to work.
install_requires=project_dir.joinpath("requirements.txt").read_text().split("\n"),
install_requires=project_dir.joinpath("requirements.txt")
.read_text(encoding="utf-8")
.split("\n"),
zip_safe=False,
license="AGPLv3",
classifiers=[
Expand Down

0 comments on commit db3e1d8

Please sign in to comment.