docs: update readme
Check and Lint / Rustfmt (pull_request) Successful in 16s
Check and Lint / Check (pull_request) Successful in 28s
Check and Lint / Clippy (pull_request) Successful in 24s
Test and Coverage / Test (pull_request) Successful in 23s
Check and Lint / Build RPM (pull_request) Successful in 29s
Check and Lint / Check (push) Successful in 17s
Check and Lint / Rustfmt (push) Successful in 16s
Test and Coverage / Coverage (pull_request) Successful in 43s
Check and Lint / Clippy (push) Successful in 18s
Test and Coverage / Test (push) Successful in 20s
Check and Lint / Build RPM (push) Successful in 29s
Release / Semantic release (push) Successful in 44s
Test and Coverage / Coverage (push) Successful in 43s
Release / Build and push RPM (push) Successful in 31s

This commit was merged in pull request #23.
This commit is contained in:
2026-08-20 09:40:46 +02:00
parent 75c687d82a
commit 805c278cb5
+13 -3
View File
@@ -18,12 +18,22 @@ aarel server # launch the server for the detected beamline
```
Each command has a single-letter alias (`p`, `g`, `s`). `--config <path>`
selects a different config file; it defaults to `data/defaults.json`.
selects a different config file; it defaults to `/etc/aarel/defaults.json`.
### Launching
`gui` and `server` pick their config entry from the detected beamline. Use
`--entry <name>` to launch a different one.
`gui` and `server` default to the deployment for the detected beamline. Pass
`-d`/`--deployment <name>` to launch a specific one:
```
aarel gui -d x10sa # launch the x10sa GUI
aarel server -d mytest # launch a custom deployment's server
aarel server --deployment x06da --env-file ./dev.env
```
Deployments found under `deployments_base` are offered alongside the configured
beamlines, so `-d` accepts either a configured beamline name or a discovered
deployment.
## Development