some cleanup/clarifications one project maintenance, building, etc...

Author: peter

.github/workflows/ci.yaml

@@ -23,7 +23,6 @@ jobs:
             - name: Run Ruff linting
               run: hatch run ruff check .
 
-
     # test:
     #     needs: lint
     #     strategy:

.pre-commit-config.yaml

@@ -19,4 +19,4 @@ repos:
           - id: check-merge-conflict
 
 default_language_version:
-    python: python3.8
+    python: python3.12

Makefile

@@ -22,13 +22,6 @@ publish: build
 publish-test: build
 	hatch publish --repo test
 
-# Legacy twine commands (deprecated, use publish/publish-test)
-release: build
-	twine upload --repository pypi dist/*
-
-release-test: build
-	twine upload --repository testpypi dist/*
-
 # Version management (using Hatch)
 version:
 	hatch version
@@ -74,7 +67,7 @@ test-cov:
 	hatch run test:pytest --cov-report=html
 
 run-demo:
-	python3 ./examples/basicExample.py
+	python3 ./examples/01_basic.py
 
 # Pre-commit
 pre-commit-install:
@@ -101,4 +94,4 @@ docs-serve: fixRelativeLinkDocs
 
 docs-deploy: fixRelativeLinkDocs
 	@echo "Deploying docs..."
-	mkdocs gh-deploy --force
+	mkdocs gh-deploy --force

README.md

@@ -218,8 +218,20 @@ export DYLD_LIBRARY_PATH=/opt/homebrew/Cellar/hidapi/<VERSION>/lib:$DYLD_LIBRARY
 
 See [troubleshooting.md](./troubleshooting.md) for help with common issues.
 
-## Used In
+## Developing / Contributing
+
+This project includes a `Makefile` with commands for creating a virtual environment (using hatch), and publishing to pypi.
+
+You will need `hatch` and `pre-commit` for this.
+You can get these by using
+
+```
+pipx install hatch==1.15.1 pre-commit
+```
 
+If you're not familiar with pipx, it lets you install python tools into isolated environments in `~/.local`.
+
+## Used In
 
 - [TeleMoMa](https://github.com/UT-Austin-RobIn/telemoma) - A Modular and Versatile Teleoperation System for Mobile Manipulation
 - [SERL](https://github.com/rail-berkeley/serl) - SERL: A Software Suite for Sample-Efficient Robotic Reinforcement Learning