Skip to content

docs: a README for visitors (what it is, downloads for the three systems, screenshots) - #84

Merged
EVMCOD merged 1 commit into
mainfrom
docs/readme-for-visitors
Oct 30, 2026
Merged

EVMCOD merged 1 commit into
mainfrom
docs/readme-for-visitors

Conversation

@EVMCOD

@EVMCOD EVMCOD commented Oct 30, 2026

Copy link
Copy Markdown
Owner

What and why

The README opened with "Python + SQLite backend, native macOS app (Tauri)" and, a few lines down, a table of BRAIN_PROVIDER / ANTHROPIC_API_KEY variables. Someone arriving from a launch page (Product Hunt, Show HN) should first see what the app is and how to get it.

New top of the README:

  • one line: "Your notes, searchable and askable, on your own computer. Free and open source (MIT).";
  • the notes home screenshot, and a paragraph on what it does (search, ask with sources, local, your own model and key, works without a key);
  • Download table: macOS (signed, notarized, updates itself; browser needs macOS 14), Linux AppImage/.deb (beta, tested on Ubuntu 22.04 and 24.04), Windows setup.exe (beta, not code-signed, with the SmartScreen steps: More info → Run anyway). All four links answer 200;
  • The first minute: choose the folder, ask or search, optionally add a key; two screenshots (ask, search);
  • And beyond your notes: the agent team, connectors (keychain only, so macOS or Linux with a keyring), MCP both ways (tools in the app; ops mcp from a source install), backups, learning from 👍/👎.

Everything technical moves under For developers, unchanged except the old "macOS app" install paragraph, which the download table replaces.

The screenshots (docs/screenshots/, ~1.2 MB) come from a fictional demo vault on a fresh install with no key; the paths shown are a made-up user's. They show the behaviour of #83 (the no-key answer quoting the decision, the dark theme): merge #83 first.

How it was tested

  • tests/test_macos_minimum.py and tests/test_portability_doc.py (both read the README) pass.
  • Download links checked with curl -I -L: 200 for the four.
  • The PNGs contain no local paths or user names (strings).

Checklist

  • No code changes.
  • No personal data and no secrets.

🤖 Generated with Claude Code

…ems, screenshots)

Someone arriving from a launch page met a table of environment variables.
The top of the README now says what ConductLoop is in one line, shows the
notes home, has downloads for macOS (signed, updates itself), Linux and
Windows (beta; Windows not code-signed, with the SmartScreen steps), the
first minute, two screenshots (ask, search) and the rest of the product in
five lines. Everything technical moves under "For developers", unchanged
except the old macOS install paragraph, now the download table.

Screenshots (docs/screenshots/) come from a fictional demo vault on a fresh
install with no key; paths in them are a made-up user's.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-30T10:58:25.482527Z b75b5d4 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@EVMCOD
EVMCOD merged commit 770b562 into main Oct 30, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant