Skip to content

Point at the editor, which nothing linked to #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codewithwan merged 1 commit into from
Jul 16, 2026
+24 −5
Merged

Point at the editor, which nothing linked to #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![CI](https://github.com/codewithwan/awan/actions/workflows/ci.yml/badge.svg)](https://github.com/codewithwan/awan/actions/workflows/ci.yml)
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](#license)
[![Build your banner](https://img.shields.io/badge/build%20your%20banner-codewithwan.github.io%2Fawan-39d353.svg)](https://codewithwan.github.io/awan/)

> A tiny living character for your terminal — and a **personality layer** any
> CLI can embed: `wait`, `ask`, `react`.
Expand Down Expand Up @@ -144,16 +145,29 @@ included.
</sub>
</p>

Copy the ready-made setup and edit one file:
### Build one without writing any JSON

**[codewithwan.github.io/awan](https://codewithwan.github.io/awan/)** — arrange
the beats, watch it play, take the three files. The preview is the engine itself
compiled to wasm, so the frames you're looking at are the frames CI will draw.

Nothing is stored and there's no server behind it: your config lives in your
repo, and the workflow runs there. That's also why the page can't break your
banner.

<p align="center">
<a href="https://codewithwan.github.io/awan/"><b>→ open the editor</b></a>
</p>

Prefer files? Copy the ready-made setup and edit one:

```sh
cp -r profile/sample/. my-profile/ # awan.json + a GitHub Action + a profile README
cargo run -p awan-profile -- whoami --config my-profile/awan.json
```

Full walkthrough, the `awan.json` format, and how to auto-regenerate it on every
push: **[`profile/`](profile)**. Built as a separate, opt-in crate, so the core
`awan` stays untouched.
Full walkthrough and the `awan.json` format: **[`profile/`](profile)**. Built as
a separate, opt-in crate, so the core `awan` stays untouched.

## Characters

Expand Down
7 changes: 6 additions & 1 deletion profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# awan profile generator
# awan profile

> **[Build one in the browser →](https://codewithwan.github.io/awan/)** Arrange
> the beats, watch it play, download the folder. The preview runs the real
> engine, so it draws the frames CI draws. Everything below is the same thing,
> by hand. generator

Turn awan into a **seam-free looping banner for your GitHub profile** — he walks
in and tells your story, then loops (~60s). A separate, opt-in tool: it never
Expand Down
Loading