diff --git a/doc/usage.md b/doc/usage.md index daba4ff..80d4b97 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -2,6 +2,80 @@ Plik opisuje przelaczniki i liste komend skryptu `workspace.py`. +## Pobranie repo i przelaczenie galezi + +Jesli trzymasz tool repo pod: + +```bash +~/dev/workspace/rv/tools/rv-launcher +``` + +to podstawowy bootstrap wyglada tak: + +```bash +mkdir -p ~/dev/workspace/rv/tools +cd ~/dev/workspace/rv/tools +git clone http://77.90.8.171:3001/edu-tools/rv-launcher.git +cd rv-launcher +``` + +Jesli w Twoim workspace narzedzia sa poza `rv/`, analogiczny katalog to: + +```bash +~/dev/workspace/tools/rv-launcher +``` + +### Najpierw token + +Przed operacjami wymagajacymi autoryzacji dodaj lokalny token do: + +```bash +~/dev/workspace/rv/tokens/gitea_tokens.json +``` + +Minimalny format pliku: + +```json +{ + "users": { + "u1": { + "tokens": { + "t1": "TU_WSTAW_TOKEN" + } + } + } +} +``` + +Ten plik powinien byc lokalny, niewersjonowany i miec prawa `600`. + +Przyklad: + +```bash +mkdir -p ~/dev/workspace/rv/tokens +chmod 700 ~/dev/workspace/rv/tokens +chmod 600 ~/dev/workspace/rv/tokens/gitea_tokens.json +``` + +### Fetch i switch + +Domyslna galaz launchera to `main`. + +Po sklonowaniu: + +```bash +git fetch origin main +git switch main +git pull --ff-only +``` + +Jesli chcesz wejsc na inna galaz, na przyklad `feat/x`, uzyj: + +```bash +git fetch origin feat/x +git switch --track -c feat/x origin/feat/x +``` + ## Wywolanie glowne ```bash