34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
# Core
|
||
|
||
Core is an opinionated Go framework for building desktop apps with Wails. It provides a small set of focused modules:
|
||
|
||
- Core — framework bootstrap and service container
|
||
- Core.Config — app and UI state persistence
|
||
- Core.Crypt — keys, encrypt/decrypt, sign/verify
|
||
- Core.Display — windows, tray, window state
|
||
- Core.Docs — in‑app help and deep‑links
|
||
- Core.IO — local/remote filesystem helpers
|
||
- [Core.Workspace](https://core.help/) — projects and paths
|
||
|
||
Help: https://Core.Help \
|
||
Web: https://dAppCo.re \
|
||
Repo: https://github.com/Snider/Core
|
||
|
||
## Quick start
|
||
```go
|
||
import core "github.com/Snider/Core"
|
||
|
||
app := core.New(
|
||
core.WithServiceLock(),
|
||
)
|
||
```
|
||
|
||
## Docs (MkDocs)
|
||
The help site and in‑app docs are built with MkDocs Material and live under `pkg/v1/core/docs`.
|
||
|
||
- Live preview: from `pkg/v1/core/docs` run
|
||
- `pip install -r requirements.txt`
|
||
- `mkdocs serve -o -c` (or `task dev` if you use Task)
|
||
- Build static site: `mkdocs build --clean -d public` (or `task build`)
|
||
|
||
The demo app embeds the built docs from `public/` and can open specific sections in new windows using stable, short headings.
|