ceos/adb-toolkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clean up proprietary README content

Browse source 
Removed proprietary information and instructions from README.
This commit is contained in:
Jesse Li-Yates 2026-06-30 12:47:04 +10:00 • committed by GitHub
commit 93b8aae567
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

35
proprietary/README.md
View file

@ -1,34 +1 @@
# Proprietary — DO NOT publish to GitHub
These are the closed-source parts of ATK (the **Logcat visual map** / live system
telemetry engine). They build into the shipped binary (obfuscated JS + native Go),
but their **source is never committed/pushed** to the public repo. `.gitignore`
keeps them untracked.
## Live files that are PROPRIETARY (kept in their build locations, gitignored)
- `frontend/src/lib/logcatgraph.ts` — the data engine (graph model, layout, particles, decay, tree/geometry placement)
- `frontend/src/components/views/LogcatMap.tsx` — the Canvas / Neon / 3D renderers + UI
- `backend_logcatpatterns.go` — the relationship-mining heuristics (ported from TS to native Go)
## Shared files that contain map *hooks* (these DO ship publicly)
- `backend_logcat.go` — calls `lcpExtractRefs`/`lcpExtractMentions`, `LogRef` struct
- `frontend/src/lib/types.ts` — `LogRef` / `RefKind` + `LogcatLine.refs/mentions`
- `frontend/src/components/views/ViewLogcat.tsx` — Text/Map toggle + mounts `<LogcatMap>`
- `frontend/vite.config.ts` — obfuscation config (lists the map files)
- `frontend/package.json` — `pixi.js`, `three` deps
- `main.go` — `ensureWebGLEnv`
> A public clone without these files **will not compile** (`backend_logcat.go`
> calls `lcpExtractRefs`/`LogRef`; `ViewLogcat.tsx` imports `<LogcatMap>`).
> Graceful map-less degradation is still a future task.
## How releases are built
**Locally, by hand.** There is no GitHub Actions auto-build — a public-repo CI
can't compile the map (these files aren't in the repo) and we don't want a
private repo / token setup. Build the `.deb` on your own machine (where the full
source lives) and upload it to the GitHub Release manually. Linux only.
## backups/
Original source of anything ported to another language, kept for future work.
- `backups/logcatpatterns.ts` — the pre-Go-port TS of the relationship miner.
**Convention:** whenever we port TS → Go, drop the original TS here so we never
lose the readable version. If you change the Go, mirror the logic back here.
empty.