docs(git): record the Forgejo remote and clone/setup steps

Documents git.phoebus.club:phoebus/phoebus_os (SSH via the port-2222 alias),
push-to-create visibility, publish.sh usage and the post-clone hook setup.
This commit is contained in:
Phoebus 2026-09-20 02:12:21 -07:00
parent 0e4fe009a8
commit 2e3888feeb

View file

@ -10,6 +10,32 @@ Ignored (see `.gitignore`): the reference ISO and other images, `installer-rs/ta
`__pycache__`, `.agent-shell/` transcripts, and any secret material
(`*.pw`, `*.key`, `*.pem`, `credentials`).
## Hosted forge and remote
The project is hosted on **Forgejo** at `git.phoebus.club`:
```
remote: origin
url: git@git.phoebus.club:phoebus/phoebus_os.git
web: https://git.phoebus.club/phoebus/phoebus_os
```
SSH uses the `Host git.phoebus.club` entry in `~/.ssh/config` (user `git`,
port 2222, laptop key), so the short `git@git.phoebus.club:...` form works. The
repository was created by Forgejo **push-to-create**, which uses the account's
default visibility; check that the repository is **public** in
`Settings -> General` (or `PATCH /api/v1/repos/phoebus/phoebus_os` with
`{"private":false}` using an API token).
`scripts/publish.sh` pushes the current branch to the configured remote after
re-running the checks:
```sh
scripts/publish.sh # origin + current branch
scripts/publish.sh origin main
git push origin v0.1.0 # publish release tags explicitly
```
## One-time migration (already performed)
```sh
@ -17,27 +43,21 @@ cd /path/to/phoebus_os
git init -b main
git add -A
git commit -m "chore: import Phoebus OS installer and Rust migration"
# ... further commits for docs and tooling ...
git config core.hooksPath .githooks # enable the committed hooks
```
Then connect the public remote and push:
```sh
git remote add origin <PUBLIC_REPO_URL>
# ... further commits for docs, tooling and the Makefile ...
git config core.hooksPath .githooks
git remote add origin git@git.phoebus.club:phoebus/phoebus_os.git
git push -u origin main
git push origin v0.1.0
```
`scripts/publish.sh` performs the push after re-running the checks. It takes the
remote and branch as arguments:
For a fresh clone on another machine:
```sh
scripts/publish.sh origin main
git clone git@git.phoebus.club:phoebus/phoebus_os.git
cd phoebus_os
scripts/setup-hooks.sh # re-enable the committed hooks
```
> The remote URL is intentionally not hard-coded. Add it once with
> `git remote add origin <URL>` and every later `scripts/publish.sh` uses it.
## Ongoing loop for a work session
```