From db3e1d8aec332c9742059e3e9f9cdc8a4cadd0af Mon Sep 17 00:00:00 2001
From: Richard Baltrusch <richard@baltrusch.net>
Date: Thu, 18 Aug 2022 14:01:53 +0200
Subject: [PATCH] Update package documentation

---
 README.md | 16 ++++------------
 setup.py  |  8 +++++---
 2 files changed, 9 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 0a4ac20..32dd873 100644
--- a/README.md
+++ b/README.md
@@ -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
 
@@ -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
 
diff --git a/setup.py b/setup.py
index 51a1d9a..dc89b4b 100644
--- a/setup.py
+++ b/setup.py
@@ -1,5 +1,5 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+"""Setup file for pip install"""
 from pathlib import Path
 
 import setuptools
@@ -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",
@@ -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=[