Merge pull request #55 from MITLibraries/update-readme-and-makefile

Update README and Makefile

Author: jonavellecuerdo

Makefile

@@ -1,51 +1,57 @@
 SHELL=/bin/bash
 DATETIME:=$(shell date -u +%Y%m%dT%H%M%SZ)
 
-help: # preview Makefile commands
+help: # Preview Makefile commands
 	@awk 'BEGIN { FS = ":.*#"; print "Usage:  make <target>\n\nTargets:" } \
 /^[-_[:alpha:]]+:.?*#/ { printf "  %-15s%s\n", $$1, $$2 }' $(MAKEFILE_LIST)
 
-## ---- Dependency commands ---- ##
+#######################
+# Dependency commands
+#######################
 
-install: # install Python dependencies
+install: # Install Python dependencies
 	pipenv install --dev
 	pipenv run pre-commit install
 
-update: install # update Python dependencies
+update: install # Update Python dependencies
 	pipenv clean
 	pipenv update --dev
 
-## ---- Unit test commands ---- ##
+######################
+# Unit test commands
+######################
 
-test: # run tests and print a coverage report
+test: # Run tests and print a coverage report
 	pipenv run coverage run --source=lambdas -m pytest -vv
 	pipenv run coverage report -m
 
-coveralls: test # write coverage data to an LCOV report
+coveralls: test # Write coverage data to an LCOV report
 	pipenv run coverage lcov -o ./coverage/lcov.info
 
-## ---- Code quality and safety commands ---- ##
+####################################
+# Code quality and safety commands
+####################################
 
-lint: black mypy ruff safety # run linters
+lint: black mypy ruff safety # Run linters
 
-black: # run 'black' linter and print a preview of suggested changes
+black: # Run 'black' linter and print a preview of suggested changes
 	pipenv run black --check --diff .
 
-mypy: # run 'mypy' linter
+mypy: # Run 'mypy' linter
 	pipenv run mypy .
 
-ruff: # run 'ruff' linter and print a preview of errors
+ruff: # Run 'ruff' linter and print a preview of errors
 	pipenv run ruff check .
 
-safety: # check for security vulnerabilities and verify Pipfile.lock is up-to-date
+safety: # Check for security vulnerabilities and verify Pipfile.lock is up-to-date
 	pipenv check
 	pipenv verify
 
-lint-apply: # apply changes with 'black' and resolve 'fixable errors' with 'ruff'
+lint-apply: # Apply changes with 'black' and resolve 'fixable errors' with 'ruff'
 	black-apply ruff-apply 
 
-black-apply: # apply changes with 'black'
+black-apply: # Apply changes with 'black'
 	pipenv run black .
 
-ruff-apply: # resolve 'fixable errors' with 'ruff'
+ruff-apply: # Resolve 'fixable errors' with 'ruff'
 	pipenv run ruff check --fix .