scott/usb-crash-cart
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README with pull-based workflow

Browse Source 
Replaces build-from-source instructions with docker pull from the Gitea
registry, since the image is now built automatically by Gitea Actions.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
scott
2026-04-07 12:38:49 -04:00
parent 7415590fba
commit 40288dfd61
1 changed files with 13 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -4,45 +4,35 @@ Docker container wrapper for the NOTECONS02 USB Crash Cart Adapter software.
The vendor software (`usb-crash-cart-adapter` v20240517) was built against Ubuntu 16.04
(Python 2.7, wxWidgets 2.9/GTK2) and is incompatible with modern Fedora. This repo runs
it inside an Ubuntu 16.04 container with X11 passthrough.
it inside an Ubuntu 16.04 container with X11/XWayland passthrough.
## Setup
## New host setup (one-time)
### 1. Install udev rules (once, on the host)
Clone the repo and install the udev rules so the crash cart adapter is accessible without root:
```bash
git clone git@git.sdgarren.com:scott/usb-crash-cart.git
cd usb-crash-cart
sudo ./install-udev-rules.sh
```
This allows the crash cart adapter (USB vendor `152a`, products `8460`/`8463`) to be
accessed without root.
Reconnect the adapter if it was already plugged in.
### 2. Place the .deb package
## Running
Copy the vendor `.deb` to `packages/crash-cart.deb`:
```bash
cp /path/to/"Linux-X64 Crash Cart Software_1240415.deb" packages/crash-cart.deb
```
### 3. Build the image
```bash
docker build -t usb-crash-cart .
```
### 4. Run
Pull the pre-built image from the Gitea registry and launch:
```bash
docker pull git.sdgarren.com/scott/usb-crash-cart:latest
./docker-run.sh
```
This handles X11 socket sharing and USB device passthrough automatically.
`docker-run.sh` handles X11/XWayland socket sharing and USB device passthrough automatically.
## Notes
- The container uses `ubuntu:16.04` to match the build environment.
- The container uses `ubuntu:16.04` to match the original build environment.
- The app bundles its own `libpython2.7`, `libwx_gtk2u-2.9`, `libpng12`, etc. — the
container only needs GTK2 and X11 system libs from the OS.
- `LD_LIBRARY_PATH` is set to prefer the bundled libs over system ones.
- The `.deb` is excluded from git (`.gitignore`) — obtain it from the vendor package.
- On Fedora with Wayland, XWayland provides X11 compatibility — no extra configuration needed.
- The Docker image is built automatically by Gitea Actions on every push to `main`.