remove dist directory before building next version

.github/workflows/python-package.yaml

@@ -28,15 +28,10 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install dependencies
-      run: |
-        pip install -r requirements.txt
-        pip install -r requirements-dev.txt
-
     - name: Run tests
       run: |
-        pytest
+        make test
 
     - name: Run linter
       run: |
-        flake8
+        make lint

Makefile

@@ -1,31 +1,34 @@
+# system python interpreter. used only to create virtual environment
+PY = python3
 VENV = venv
+BIN=$(VENV)/bin
 
 ifeq ($(OS), Windows_NT)
 	BIN=$(VENV)/Scripts
-else
+	PY=python
-	BIN=$(VENV)/bin
 endif
 
 
 all: lint test
 
 $(VENV): requirements.txt requirements-dev.txt setup.py
-	python3 -m venv $(VENV)
+	$(PY) -m venv $(VENV)
-	$(BIN)/python3 -m pip install --upgrade -r requirements.txt
+	$(BIN)/pip install --upgrade -r requirements.txt
-	$(BIN)/python3 -m pip install --upgrade -r requirements-dev.txt
+	$(BIN)/pip install --upgrade -r requirements-dev.txt
-	$(BIN)/python3 -m pip install -e .
+	$(BIN)/pip install -e .
 	touch $(VENV)
 
 test: $(VENV)
-	$(BIN)/python3 -m pytest
+	$(BIN)/pytest
 .PHONY: test
 
 lint: $(VENV)
-	$(BIN)/python3 -m flake8
+	$(BIN)/flake8
 .PHONY: lint
 
 release: $(VENV)
-	$(BIN)/python3 setup.py sdist bdist_wheel
+	rm -rf dist
+	$(BIN)/python setup.py sdist bdist_wheel
 	$(BIN)/twine upload dist/*
 .PHONY: release
 

README.md

@@ -1,11 +1,32 @@
-# blag -- a simple, blog-aware static site generator
+# blag
 
-## Installation
+blag is a blog-aware, static site generator, written in [Python][].
+
+blag is named after [the blag of the webcomic xkcd][blagxkcd].
+
+[python]: https://python.org
+[blagxkcd]: https://blog.xkcd.com
+
+
+## Features
+
+* Write content in [Markdown][]
+* Theming support using [Jinja2][] templates
+* Generation of Atom feeds for blog content
+* Fenced code blocks and syntax highlighting using [Pygments][]
+
+blag runs on Linux, Mac and Windows and requires Python >= 3.8
+
+[markdown]: https://daringfireball.net/projects/markdown/
+[jinja2]: https://palletsprojects.com/p/jinja/
+[pygments]: https://pygments.org/
+
+
+## Quickstart
 
 ```bash
-$ pip install blag
+$ pip install blag                  # 1. install blag
+$ blag quickstart                   # 2. create a new site
+$ vim content/hello-world.md        # 3. create some content
+$ blag build                        # 4. build the website
 ```
-
-## Usage
-
-TBD

blag/version.py

@@ -1 +1 @@
-__VERSION__ = '0.0.2'
+__VERSION__ = '0.0.3'

setup.py

@@ -10,7 +10,7 @@ meta['long_description'] = open('./README.md').read()
 setup(
     name='blag',
     version=meta['__VERSION__'],
-    description='simple blog-aware static site generator',
+    description='blog-aware, static site generator',
     long_description=meta['long_description'],
     long_description_content_type='text/markdown',
     keywords='markdown blag blog static site generator cli',