translate to english
This commit is contained in:
@@ -1,72 +1,73 @@
|
||||
# devarea
|
||||
|
||||
A TTG workspace kezelő repója: innen klónozható le a teljes workspace a
|
||||
kategória-mappás struktúrában, és itt ellenőrizhető, hogy a klón lista
|
||||
szinkronban van-e a Gitea szerverrel (`git.teletypegames.org`).
|
||||
Workspace management repo for TTG: use it to clone the whole workspace in
|
||||
its category-folder structure, and to verify that the clone list is in sync
|
||||
with the Gitea server (`git.teletypegames.org`).
|
||||
|
||||
## Gyors start
|
||||
## Quick start
|
||||
|
||||
Új gépen:
|
||||
On a fresh machine:
|
||||
|
||||
```sh
|
||||
mkdir TTG && cd TTG
|
||||
git clone ssh://git@git.teletypegames.org:2222/tools/devarea
|
||||
cd devarea
|
||||
make setup # tea telepítés + összes repo klónozása + ellenőrzés
|
||||
make setup # install tea + clone all repos + check
|
||||
```
|
||||
|
||||
A repók a devarea szülőkönyvtárába (a workspace gyökerébe) kerülnek. Más
|
||||
célmappa: `make clone ROOT=/path/to/workspace`.
|
||||
Repos are cloned into the parent directory of the devarea checkout (the
|
||||
workspace root). To use a different target: `make clone ROOT=/path/to/workspace`.
|
||||
|
||||
## Make targetek
|
||||
## Make targets
|
||||
|
||||
| Target | Mit csinál |
|
||||
| Target | What it does |
|
||||
|---|---|
|
||||
| `make help` | Elérhető targetek listája (alapértelmezett) |
|
||||
| `make tea` | tea (Gitea CLI) telepítése Homebrew-val, ha hiányzik, és a login ellenőrzése |
|
||||
| `make clone` | Az összes repo klónozása a `scripts/repos.list` alapján; a már létezőket kihagyja |
|
||||
| `make check` | A klón lista összevetése a szerverrel (`tea repo list --output json`) |
|
||||
| `make setup` | Mindhárom egyben: tea + clone + check |
|
||||
| `make help` | List available targets (default) |
|
||||
| `make tea` | Install tea (Gitea CLI) via Homebrew if missing, and verify the login |
|
||||
| `make clone` | Clone all repos based on `scripts/repos.list`; existing ones are skipped |
|
||||
| `make check` | Compare the clone list against the server (`tea repo list --output json`) |
|
||||
| `make setup` | All three in one: tea + clone + check |
|
||||
|
||||
## Scriptek
|
||||
## Scripts
|
||||
|
||||
Minden script a `scripts/` alatt van, és önállóan is futtatható:
|
||||
All scripts live under `scripts/` and can also be run standalone:
|
||||
|
||||
- **`install-tea.sh`** — tea telepítés + login ellenőrzés. Login nélkül
|
||||
kiírja a beállító parancsot (`tea login add --name ttg --url
|
||||
- **`install-tea.sh`** — installs tea and verifies the login. Without a
|
||||
login it prints the setup command (`tea login add --name ttg --url
|
||||
https://git.teletypegames.org`).
|
||||
- **`clone-repos.sh [cél-mappa]`** — a `repos.list` minden sorát leklónozza
|
||||
a megadott struktúrában. Idempotens: a már létező klónokat kihagyja.
|
||||
- **`check-repos.sh`** — két irányban ellenőriz: ami a szerveren van, de a
|
||||
listából hiányzik (**HIÁNYZIK**), és ami a listában Gitea repóként
|
||||
szerepel, de a szerveren nincs (**FELESLEG**). Bármelyik találat esetén
|
||||
1-gyel lép ki, így CI-ban is használható.
|
||||
- **`clone-repos.sh [target-dir]`** — clones every line of `repos.list`
|
||||
into the given structure. Idempotent: existing clones are skipped.
|
||||
- **`check-repos.sh`** — checks in both directions: repos that exist on
|
||||
the server but are missing from the list (**MISSING**), and repos listed
|
||||
as Gitea repos but absent from the server (**STALE**). Exits with 1 on
|
||||
any hit, so it is CI-friendly.
|
||||
|
||||
## Adatfájlok
|
||||
## Data files
|
||||
|
||||
- **`scripts/repos.list`** — a klónozandó repók, soronként
|
||||
`<workspace-relatív út>|<clone URL>` formában. Új repó a szerveren →
|
||||
ide kell felvenni (a `make check` szól, ha kimaradt). Nem-Gitea repók
|
||||
(GitHub) is szerepelhetnek benne, azokat a check kihagyja.
|
||||
- **`scripts/repos.ignore`** — szerveren létező, de szándékosan nem
|
||||
klónozott repók (`<owner>/<name>`), ezeket a check nem jelzi hiányzóként.
|
||||
- **`scripts/repos.list`** — the repos to clone, one per line in
|
||||
`<workspace-relative path>|<clone URL>` form. New repo on the server →
|
||||
add it here (`make check` will complain if it is missing). Non-Gitea
|
||||
repos (GitHub) may also appear; the check skips those.
|
||||
- **`scripts/repos.ignore`** — repos that exist on the server but are
|
||||
intentionally not cloned (`<owner>/<name>`); the check does not report
|
||||
these as missing.
|
||||
|
||||
## Workspace struktúra
|
||||
## Workspace structure
|
||||
|
||||
```
|
||||
TTG/
|
||||
├── devarea/ # ez a repo
|
||||
├── devarea/ # this repo
|
||||
├── teletypegames/ # public site monorepo (GitHub)
|
||||
├── wiki-pages/ # wiki mirror (Grav)
|
||||
├── archive/ # lezárt projektek
|
||||
├── demos/ # engine-demók, kísérletek
|
||||
├── games/ # játékok
|
||||
├── media/ # asset-ek, képek (nem git)
|
||||
├── tools/ # önálló toolok, infra
|
||||
├── tools_bbs/ # BBS-es cuccok
|
||||
├── tools_build/ # engine/build toolchainek (*-tools)
|
||||
└── tools_libs/ # saját libek (inkwell, rubbs, gorpg)
|
||||
├── archive/ # retired projects
|
||||
├── demos/ # engine demos, experiments
|
||||
├── games/ # games
|
||||
├── media/ # assets, images (not git)
|
||||
├── tools/ # standalone tools, infra
|
||||
├── tools_bbs/ # BBS-related repos
|
||||
├── tools_build/ # engine/build toolchains (*-tools)
|
||||
└── tools_libs/ # own libraries (inkwell, rubbs, gorpg)
|
||||
```
|
||||
|
||||
A repók és a wiki oldalak kapcsolatát a [WIKI_CONNECTION.md](WIKI_CONNECTION.md)
|
||||
írja le.
|
||||
The mapping between repos and wiki pages is described in
|
||||
[WIKI_CONNECTION.md](WIKI_CONNECTION.md).
|
||||
|
||||
Reference in New Issue
Block a user