diff --git a/README.md b/README.md index cff8902..acc0d1d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # RV Launcher -Repo `rv-launcher` zawiera narzędzie do pracy z workspace RISC-V. W pierwszej -kolejności służy ono do zarządzania tokenami; pozostałe funkcje obejmują pracę -z kartami pracy i uruchamianie środowiska kontenerowego. +Repo `rv-launcher` zawiera narzędzie do pracy ze wspólnym workspace EDU. +W pierwszej kolejności służy ono do zarządzania tokenami; pozostałe funkcje +obejmują pracę z kartami pracy i uruchamianie środowiska kontenerowego. Właściwym skryptem CLI jest wykonywalny plik `rvctl.py`. To on implementuje zarządzanie tokenami, listowanie serii i kart, przygotowanie repo odpowiedzi i @@ -111,15 +111,9 @@ Po tym kroku w workspace jest już repo launchera: └── rv-launcher ``` -Repo `workspace-info` trzymamy osobno od narzędzi, w katalogu `meta`: - -```text -~/dev/workspace/rv -├── meta -│ └── workspace-info -└── tools - └── rv-launcher -``` +Repo `workspace-info` nie jest częścią `tools`. `rvctl` pobierze je +automatycznie do `meta/workspace-info` przy pierwszej komendzie zależnej od +manifestu, na przykład `series list`. Etap 3: wczytaj token z remota do lokalnego store: @@ -290,33 +284,36 @@ item server proto host org repo user remote tok ## Kolejny krok: serie i karty pracy -Po konfiguracji tokenów najpierw sprawdź stan store: - -```bash -./rvctl tokens compare -``` - -Następnie wylistuj dostępne serie. Jeżeli manifestu `workspace-info` jeszcze -nie ma, `rvctl` pobierze go automatycznie do `meta/workspace-info`. Jeżeli -katalog `series` w workspace jeszcze nie istnieje, `rvctl` utworzy go -automatycznie: - -```bash -./rvctl series list -``` - -Manifest trafia do: +Po konfiguracji tokenów następnym elementem jest publiczny manifest wspólnego +workspace. `rvctl` szuka go lokalnie w: ```text ~/dev/workspace/rv/meta/workspace-info ``` +Manifest zawiera listę serii, kart, repozytoriów źródłowych, repozytoriów +odpowiedzi i branchy. Nie zawiera tokenów ani lokalnych plików ucznia. + +Nie musisz pobierać go ręcznie. Pierwsza komenda zależna od manifestu, na +przykład `series list`, automatycznie sklonuje repo +`edu-workspace/workspace-info`, jeżeli lokalnej kopii jeszcze nie ma: + +```bash +./rvctl series list +``` + Jeżeli chcesz jawnie odświeżyć istniejący manifest, użyj: ```bash ./rvctl workspace sync ``` +Przed pobieraniem kart warto jeszcze sprawdzić stan tokenów: + +```bash +./rvctl tokens compare +``` + Przykładowy wynik: ```text