Clarify rvctl README wording

This commit is contained in:
mpabi
2026-04-29 00:47:43 +02:00
parent 8655a97347
commit 0923646add
+11 -17
View File
@@ -1,27 +1,21 @@
# RV Launcher
`rv-launcher` jest narzedziem do pracy z workspace RISC-V. Wlasciwym skryptem
CLI jest wykonywalny plik `rvctl.py`; to on implementuje listowanie serii i
kart, obsluge tokenow, przygotowanie repo odpowiedzi i start kontenera.
`rv-launcher` jest narzedziem do pracy z workspace RISC-V. Publiczna komenda
narzedzia to `rvctl`; obsluguje tokeny, listuje serie i karty, przygotowuje
repo odpowiedzi i uruchamia kontener.
Publicznym entrypointem dla uzytkownika jest krotki wrapper:
`rvctl` jest krotkim wrapperem:
```bash
./rvctl
```
Wrapper uruchamia `python3 rvctl.py "$@"`. `rvctl.py` mozna tez uruchomic
bezposrednio:
```bash
./rvctl.py
```
Sciezki i domyslne ustawienia sa trzymane w `workspace.json`.
Wrapper uruchamia wykonywalny skrypt `rvctl.py`. Sciezki i domyslne ustawienia
sa trzymane w `workspace.json`.
## Co robi narzedzie
CLI porzadkuje prace w trzech obszarach.
`rvctl` porzadkuje prace w trzech obszarach.
1. Zarzadzanie tokenami
@@ -31,13 +25,13 @@ CLI porzadkuje prace w trzech obszarach.
2. Listowanie i pobieranie kart pracy
`rvctl.py` czyta serie i karty z workspace, pomaga wybrac material do pracy
`rvctl` czyta serie i karty z workspace, pomaga wybrac material do pracy
oraz przygotowuje remotes potrzebne do repo odpowiedzi. Szczegoly komend
`list-series`, `list-cards` i `submission` sa w `doc/rvctl.md`.
3. Uruchamianie srodowiska programistycznego w kontenerach
Dla wybranej karty `rvctl.py` uruchamia sesje tmux i kontener z przygotowanym
Dla wybranej karty `rvctl` uruchamia sesje tmux i kontener z przygotowanym
srodowiskiem developerskim. Szczegoly komendy `tmux-container` sa w
`doc/rvctl.md`.
@@ -67,7 +61,7 @@ Typowy uklad:
~/dev/workspace/rv/tokens/tokens.json
```
`rvctl.py` pracuje na kartach z `series_root` w workspace. Repo zrodlowe w
`rvctl` pracuje na kartach z `series_root` w workspace. Repo zrodlowe w
`~/dev/edu/repos/rv` sa punktem odniesienia i fallbackiem dla narzedzi.
## Szybki start
@@ -82,7 +76,7 @@ Najpierw zobacz konfiguracje i dostepne komendy:
Typowy przeplyw pracy:
```bash
./rvctl tokens scan
./rvctl tokens compare
./rvctl list-series
./rvctl list-cards inf
./rvctl tmux-container inf 03 --dry-run