b.ReX
/
webavatar-core
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Format project documentation and homepage

main
Jonathan Hinkel 2 months ago
parent
0bb02c4014
commit
851988aa36
2 changed files with 18 additions and 14 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 16
      README.md
  2. 16
      src/routes/+page.svelte

16
README.md
View File

@ -24,11 +24,11 @@ Open [`/demo/realtime`](http://localhost:5173/demo/realtime) for the realtime se
## Documentation ## Documentation
| Subsystem | Doc | | Subsystem | Doc |
| ------------------------------------------------------------- | --------------------------------------------------- | | -------------------------------------------------------- | ---------------------------------------------------- |
| Architecture overview and module layering | [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | | Architecture overview and module layering | [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) |
| Realtime session management | [docs/REALTIME_SESSION.md](docs/REALTIME_SESSION.md) | | Realtime session management | [docs/REALTIME_SESSION.md](docs/REALTIME_SESSION.md) |
| Tool calling (server- and client-executed) | [docs/TOOLS.md](docs/TOOLS.md) | | Tool calling (server- and client-executed) | [docs/TOOLS.md](docs/TOOLS.md) |
| Analytics recording | [docs/ANALYTICS.md](docs/ANALYTICS.md) | | Analytics recording | [docs/ANALYTICS.md](docs/ANALYTICS.md) |
| Configuration (env vars, persona) | [docs/CONFIGURATION.md](docs/CONFIGURATION.md) | | Configuration (env vars, persona) | [docs/CONFIGURATION.md](docs/CONFIGURATION.md) |
| `humanoid` package (avatar-state, animation composition) | [docs/HUMANOID.md](docs/HUMANOID.md) | | `humanoid` package (avatar-state, animation composition) | [docs/HUMANOID.md](docs/HUMANOID.md) |

16
src/routes/+page.svelte
View File

@ -4,19 +4,23 @@
<h1>webavatar-core</h1> <h1>webavatar-core</h1>
<p> <p>
A base SvelteKit project for webavatar client projects. It provides the reusable A base SvelteKit project for webavatar client projects. It provides the reusable infrastructure
infrastructure those projects would otherwise reimplement from scratch — session management, those projects would otherwise reimplement from scratch — session management, auth tokens, and the
auth tokens, and the realtime model connection — as a foundation to branch from, not a finished realtime model connection — as a foundation to branch from, not a finished product.
product.
</p> </p>
<h2>Demos</h2> <h2>Demos</h2>
<ul> <ul>
<li><a href={resolve('/demo/realtime')}>/demo/realtime</a> — realtime session reference wiring</li> <li>
<a href={resolve('/demo/realtime')}>/demo/realtime</a> — realtime session reference wiring
</li>
<li> <li>
<a href={resolve('/demo/humanoid')}>/demo/humanoid</a> — humanoid avatar-state derivation <a href={resolve('/demo/humanoid')}>/demo/humanoid</a> — humanoid avatar-state derivation
</li> </li>
</ul> </ul>
<h2>Docs</h2> <h2>Docs</h2>
<p>See <code>docs/ARCHITECTURE.md</code> in the repo for the full architecture map, or the README for getting started.</p> <p>
See <code>docs/ARCHITECTURE.md</code> in the repo for the full architecture map, or the README for getting
started.
</p>

Write Preview
Loading…
Cancel
Save