Skip to content

Tiago pro, docs, docker changes#13

Open
dtotsila wants to merge 15 commits intomainfrom
tiago_pro
Open

Tiago pro, docs, docker changes#13
dtotsila wants to merge 15 commits intomainfrom
tiago_pro

Conversation

@dtotsila
Copy link
Copy Markdown
Contributor

@dtotsila dtotsila commented May 7, 2026

This pull request introduces a streamlined, production-ready developer workflow for the ROS 2 Vive Controller project. The main changes include the addition of a .env-based configuration system, a new Makefile for simplified Docker management, and significant improvements to the documentation for clarity and usability. The entrypoint script for CI environments has also been added. These changes make setup, deployment, and hardware mapping much easier and more robust.

Developer Workflow & Configuration

  • Added a .env.template file to standardize configuration of Steam credentials, ROS domain ID, scaling factors, and hardware serials; users now copy and edit .env for their setup.
  • The Makefile now automates all Docker build, run, and utility commands (e.g., build, pull, calibrate, identify, stop, clean), sourcing .env variables and providing robot-specific targets for deployment.

Documentation Improvements

  • Completely rewrote the README.md to reflect the new workflow: clarified prerequisites, added step-by-step configuration and deployment instructions, documented the new Makefile commands, and improved explanations of the driver node, TF tree, and hardware mapping.

Continuous Integration

  • Added .ci/entrypoint.sh to ensure ROS and workspace environments are sourced correctly in CI/CD and Docker environments.

@dtotsila dtotsila requested a review from jbmouret May 7, 2026 09:31
@dtotsila dtotsila added documentation Improvements or additions to documentation enhancement New feature or request labels May 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant