Documentation touch-ups

p3zo · Jun 17, 2024 · 6450994 · 6450994
1 parent da6664f
commit 6450994
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 14 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -8,7 +8,7 @@ COPY chord_progressions $APP_DIR/chord_progressions/
 COPY tests $APP_DIR/tests/
 COPY requirements.txt $APP_DIR/requirements.txt
 COPY setup.cfg $APP_DIR/setup.cfg
-COPY setup.py $APP_DIR/setup.py
+COPY pyproject.toml $APP_DIR/pyproject.toml
 
 WORKDIR $APP_DIR
 

diff --git a/README.md b/README.md
@@ -1,8 +1,14 @@
 # Chord progressions
 
-## Usage
+`chord-progressions` is a provides utility functions for extracting, analyzing, and generating chord progressions.
 
-See the [Makefile](Makefile) for available actions.
+## Development
+
+Configuration for local development with Docker is provided. Run `make build` to build the container, `make shell` to
+get a shell inside of it for ad-hoc usage, and `make test` to run all unit tests inside the container. See
+the [Makefile](Makefile) for all available actions.
+
+To upgrade the version and trigger a new release, use `bump-my-version bump minor chord_progressions/__init__.py`.
 
 ## Docs
 
@@ -20,7 +26,8 @@ Analysis
 
 I/O
 
-- [feature] add `from_audio` and `from_midi` constructors to Progression class
+- [feature] add `from_audio` and `from_midi` constructors to Progression class to enable
+  e.g. `progression = chord_progressions.Progression.from_midi('my_file.mid')`
 - [maintainability] use a singular method of counting in `extract_harman.py`
     - `get_segment_label` uses counter
     - `get_segment_pc_weights` uses defaultdict

diff --git a/docs/extract.md b/docs/extract.md
@@ -19,11 +19,3 @@ from chord_progressions.extract.audio import extract_progression_from_audio
 
 progression = extract_progression_from_audio('my_file.wav')
 ```
-
-## Eventual interface
-
-```python
-import chord_progressions
-progression = chord_progressions.Progression.from_audio('my_file.wav')
-progression = chord_progressions.Progression.from_midi('my_file.mid')
-```
diff --git a/docs/generate.md b/docs/generate.md
@@ -1,4 +1,4 @@
-# Generaton settings
+# Generate
 
 ## Constraints
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,5 +30,5 @@ edit_uri: ""
 nav:
   - Introduction: index.md
   - Extract: extract.md
-  - Generator settings: generate.md
+  - Generate: generate.md
   - Glossary: glossary.md