Skip to content

armgit / andee

Public Imported from GitHub
0

Andee lives on your phone or Mac and uses any app like you do—no integrations, no root, any model; memory and passwords never leave your device | Andee 住进你的手机或 Mac,像你一样操作任何 App——无需集成、无需 Root、支持任意模型,记忆和密码绝不离开设备。

docs(readme): ask people what they built with it, and mean it

booboosui2ef08d53bef3
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 5a36a50..68a6964 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -3,9 +3,10 @@
#
# Two repository settings have to be on for these links to work, and nothing in the
# repo can turn them on:
-# 1. GitHub Discussions (Settings → Features → Discussions) with a "Q&A" category.
-# Without it, `blank_issues_enabled: false` leaves a user with a bug that is not
-# a bug and nowhere to put it.
+# 1. GitHub Discussions (Settings → Features → Discussions) with a "Q&A" category
+# AND a "Show and tell" category. Without it, `blank_issues_enabled: false`
+# leaves a user with a bug that is not a bug and nowhere to put it, and the
+# Showcase section of the README points at a 404.
# 2. Private vulnerability reporting (Settings → Security → Private vulnerability
# reporting). Until it is on, the first contact link 404s. See SECURITY.md.
@@ -21,6 +22,10 @@ contact_links:
url: 'https://github.com/kuafuai/andee/discussions/categories/q-a'
about: "Not a bug — a question. \"Accessibility service keeps turning itself off\", \"which ROMs are known to work\", \"how do I build this\" all belong here."
+ - name: "\U0001F3AC Show and tell — what you built with it"
+ url: 'https://github.com/kuafuai/andee/discussions/categories/show-and-tell'
+ about: "The odd workaround, the thing it turned out to be able to do, the recording that made you laugh. Not a bug and not a question — a story. Read the Showcase section of the README first, including the part about blurring anything private: this app reads the screen, so a screenshot is a picture of your messages."
+
- name: "\U0001F512 Permission justification"
url: 'https://github.com/kuafuai/andee/blob/main/docs/permissions.md'
about: Why the app asks for SMS, call log, contacts, and accessibility — what each one buys, and what happens if you refuse it. Read before filing a permission-related issue.
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 12d5ca4..e0e8be3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -27,6 +27,19 @@ build time would close this hole; it is not implemented yet.)
### Added
+- **Both READMEs now ask for your use case (`## Showcase` / `## 好玩的用法`).** The
+ README described what the thing can do and never asked anyone to show what they did with it,
+ which is how a project ends up with no idea whether the odd corners work. The section is an
+ invitation and three things that make a post useful: the device and ROM (this app talks to Android
+ at a level where ROMs disagree, so "worked on my phone" is not reproducible), the sentence you
+ actually said, and a link if there is one. It goes to a Discussions **Show and tell** rather than
+ the issue tracker, which follows the rule `config.yml` already sets — the tracker is for
+ reproducible defects, and a story is not one. Two details are deliberate rather than decorative.
+ **GitHub cannot play a video inside a README** (iframes are stripped, so a YouTube link stays a
+ link), and the section hands over the thumbnail form that makes it look like a player anyway,
+ rather than letting twenty people discover that separately. And it says plainly that **a
+ screenshot of this app is a picture of your messages** — the one thing in a showcase that can do
+ real harm is posting someone's private screen content, including your own.
- `LICENSE` — Apache-2.0 with additional conditions (Part A: no multi-tenant SaaS, no
white-labelling that removes the branding, no embedding it in another product without written
authorisation). Note that GitHub reports this as `NOASSERTION`.
diff --git a/README.md b/README.md
index 4322412..23b21c4 100644
--- a/README.md
+++ b/README.md
@@ -789,6 +789,32 @@ tools/ device-side helper scripts, the ball-face lab runners, l
CLAUDE.md architecture notes written for AI coding assistants (English)
```
+## Showcase
+
+**Built something with it? Show us.** The ones worth collecting are usually the ones nobody planned
+— the odd workaround, the thing it turned out to be able to do, the one that made you laugh. It does
+not have to be useful.
+
+Post it in **[Show and tell](https://github.com/kuafuai/andee/discussions/categories/show-and-tell)**,
+one case per post, so each one can be discussed on its own. Three things make a post useful to the
+next person:
+
+- **What it ran on** — device, Android version, ROM. This app talks to Android at a level where ROMs
+ disagree, so "worked on my phone" tells a reader almost nothing.
+- **What you asked for, and what it actually did** — the sentence you really said is more
+ interesting than a summary of it.
+- **A link, if you have one** — YouTube, Bilibili, X, your own blog, anything public. GitHub cannot
+ play a video inside a README, so it will be a clickable link rather than a player. On YouTube you
+ can make it a thumbnail that looks like one:
+
+[![Watch it](https://img.youtube.com/vi/VIDEO_ID/hqdefault.jpg)](https://www.youtube.com/watch?v=VIDEO_ID)
+
+(substitute the id from the video's URL — `youtube.com/watch?v=VIDEO_ID`)
+
+**One thing here is not a formality: this app reads the screen.** A screenshot or a recording is a
+picture of your messages, your notifications, and whatever else happened to be open at the time.
+Blur or avoid anything private — yours or anyone else's — before it goes up.
+
## Contributing
- **Code** — read [CONTRIBUTING.md](CONTRIBUTING.md) ([中文](CONTRIBUTING.zh-CN.md)) first. It covers
@@ -824,6 +850,7 @@ CLAUDE.md architecture notes written for AI coding assistants (Eng
| Channel | Use it for |
|---|---|
| Issue tracker | Reproducible bugs, engineering work |
+| Show and tell | What you built with it, fun or not — see [Showcase](#showcase) |
| Security | Vulnerabilities — privately, never in a public issue. See [SECURITY.md](SECURITY.md) |
| Product / online | Trying Andee without building it yourself — [codeflying.app](https://www.codeflying.app) · [codeflying.net](https://www.codeflying.net) |
diff --git a/README.zh-CN.md b/README.zh-CN.md
index effc545..0410591 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -708,6 +708,27 @@ tools/ 设备侧小工具、球脸验收 runner、许可证审
CLAUDE.md 给 AI 编码助手看的架构说明(英文)
```
+## 好玩的用法
+
+**用它做过什么?说来听听。** 值得收的往往不是"正经用途"—— 是你绕的那个弯、是它居然真能做成的
+那件事、是把你逗乐的那一下。**不实用也可以。**
+
+发到 **[Show and tell](https://github.com/kuafuai/andee/discussions/categories/show-and-tell)**,
+一个帖子讲一个,这样每个都能单独聊。想让下一个人看得懂,三件事最好带上:
+
+- **跑在什么机器上** —— 机型、Android 版本、ROM。这个应用和 Android 打交道的层次上,各家 ROM 是
+ 有分歧的,"我手机上能用"对别人几乎等于没说。
+- **你说了什么,它真做了什么** —— 你原话那句,往往比概括出来的有意思。
+- **有链接就贴** —— YouTube、B站、微博、自己的博客,公开的就行。GitHub 的 README 放不了视频
+ 播放器,它只能是个可点的链接。YouTube 的话可以做成缩略图,看起来就像个播放器:
+
+[![点开看](https://img.youtube.com/vi/VIDEO_ID/hqdefault.jpg)](https://www.youtube.com/watch?v=VIDEO_ID)
+
+(把 `VIDEO_ID` 换成视频地址里的那一段 —— `youtube.com/watch?v=VIDEO_ID`)
+
+**有一件事不是客套:这个应用是读屏幕的。** 截图或录屏,就是你消息、通知、当时开着的一切的实拍。
+发之前把涉及隐私的地方挡掉 —— 你自己和别人的都算。
+
## 参与贡献
- **代码** —— 先读 [CONTRIBUTING.zh-CN.md](CONTRIBUTING.zh-CN.md)。里面有代码风格,以及这个仓库里**三种
@@ -741,6 +762,7 @@ CLAUDE.md 给 AI 编码助手看的架构说明(英文)
|---|---|
| Issue 跟踪 | 可复现的 bug、工程事项(**请带上设备型号 / Android 版本 / ROM / logcat**) |
| 讨论区 / 问答 | 装机求助、想法、"这个能不能做" |
+| 好玩的用法 | 你用它做过什么,实用不实用都行 —— 见[好玩的用法](#好玩的用法) |
| 安全 | 漏洞 —— 走私密渠道,永远不要开公开 issue。见 [SECURITY.md](SECURITY.md) |
| 产品 / 在线 | 不想自己打包就想试 Andee —— [codeflying.net](https://www.codeflying.net) · [codeflying.app](https://www.codeflying.app) |