Rename app and document virtual environment setup

This commit is contained in:
2026-08-25 22:18:31 +02:00
parent 2f6077f5d8
commit e845ae7eb6
5 changed files with 36 additions and 12 deletions
+20 -3
View File
@@ -1,4 +1,4 @@
# ArduSub Minimal Control
# SUB Control
A deliberately small, low-bandwidth MAVLink controller for bench-testing an
ArduSub vehicle over a USB serial connection. It sends no parameter-list
@@ -33,14 +33,31 @@ the frame mixing and generates the configured ESC outputs. For ArduSub,
## Run on Windows
1. Install Python 3.11 or newer.
2. Open PowerShell in this folder and run `./run.ps1`.
1. Install Python 3.11 or newer. A virtual environment installs packages, but
it does not install Python itself.
2. Open PowerShell in this folder and run `./run.ps1` (or right-click it and
choose **Run with PowerShell**).
3. Select the autopilot's COM port, then click **Connect**. Baud and control-rate
settings are under the small `•••` link button (normally 57600 baud / 20 Hz).
4. Confirm `ArduSub` and a live heartbeat are shown.
5. Click **Set MANUAL**, then **ARM** only when the bench is safe.
6. Move the controls. Once armed, no additional enable button is needed.
`run.ps1` automatically creates a private `.venv` on the first run, installs
the versions declared in `requirements.txt`, and starts SUB Control. Later runs
reuse the same environment and update missing dependencies when necessary.
The `.venv` directory is intentionally ignored by Git: virtual environments
contain machine-specific executables and can be recreated from
`requirements.txt`.
## Repository layout
The Gitea repository is named `argo`. `SUB Control` is a normal directory inside
that repository containing this application. A Gitea **Project** is a planning
board for issues and tasks; source code is not attached to a Project board.
Git tracks the folder automatically because its files are committed on the
repository's `main` branch.
Keyboard controls for SimpleROV-3: W/S forward/back, A/D yaw left/right,
Q/E alternative yaw control, and R/F rise/dive.
Releasing movement keys eases their controls back to neutral.