edu/stem-launcher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify rvctl README wording

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