docs: add usage notes

This commit is contained in:
2026-05-13 16:55:27 +08:00
parent a0f2860a57
commit 9af18f400c
5 changed files with 50 additions and 19 deletions

View File

@@ -1,19 +1,47 @@
# README
# SGG AI Skill Manager Windows
## About
Wails desktop app for managing AI skills from a Gitea organization. A Gitea repository is treated as a skill only when `SKILL.md` exists at the repository root.
This is the official Wails React-TS template.
## Usage
You can configure the project by editing `wails.json`. More information about the project settings can be found
here: https://wails.io/docs/reference/project-config
1. Open the app and configure Gitea `baseURL`, organization, and authentication.
2. Use username/password by default, or switch to token authentication.
3. Save the config, then use Remote Market to refresh available skills.
4. Download a skill to clone it under `%APPDATA%\sgg-ai-skill-manager\repos\{org}\{repo}`.
5. Use Local Skills to install a downloaded skill into Codex or Claude.
## Live Development
Install creates Windows directory Junctions:
To run in live development mode, run `wails dev` in the project directory. This will run a Vite development
server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser
and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect
to this in your browser, and you can call your Go code from devtools.
```text
C:\Users\{user}\.codex\skills\{repo}
-> %APPDATA%\sgg-ai-skill-manager\repos\{org}\{repo}
## Building
C:\Users\{user}\.claude\skills\{repo}
-> %APPDATA%\sgg-ai-skill-manager\repos\{org}\{repo}
```
To build a redistributable, production mode package, use `wails build`.
Uninstall removes only the Junction created by this app. Delete removes the local cloned skill after safe uninstall of recorded Junctions.
## Local Data
```text
%APPDATA%\sgg-ai-skill-manager\config.json
%APPDATA%\sgg-ai-skill-manager\state.json
%APPDATA%\sgg-ai-skill-manager\repos
```
Passwords and tokens are stored through Windows Credential Manager, not in JSON files.
## Development
```powershell
go test ./...
npm --prefix frontend run build
wails dev
```
## Build
```powershell
wails build
```