diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f02be99 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# newOS4 + +A browser terminal: a filesystem, a command shell, an editor and a tool-calling AI agent that all live +in one page, backed by a WebDAV space. + +## Status and scope + +newOS4 is the terminal that runs **WebX11** user spaces (`https://webx11.duckdns.org/spaces/newos4/`). +It is published here so the code can be read, audited and studied — it is **not** a packaged product: +it expects a WebX11 host to provide + +* WebDAV storage at `/spaces/<user>/` (nginx + `dav-auth-check`), +* the session API at `/api/auth/*`, +* the metered AI gateway at `/ollama/*` (`webx11-aigateway`). + +Several defaults still point at the author's host (`https://webx11.duckdns.org`); a self-hosted +deployment must change them (grep `webx11.duckdns.org`). + +## Layout + +| Path | What | +|---|---| +| `main.html` | the page; loads `modules/core/core-bundle.js` | +| `modules/core/` | terminal, filesystem, AI assist, orchestrator, model profiles | +| `modules/ext/` | individually loaded extensions (webdav, alias, busybox, course, …) | +| `api/chat/` | the chat bridge endpoints (PHP, token-scoped) | +| `api/debug/` | health/report/feedback endpoints | +| `scripts/` | maintenance and triage tools | +| `course/`, `help.html`, `cheatsheet.html` | built-in documentation | +| `CHANGELOG.md` | every shipped fix, symptom → cause → fix → verified | + +## Version + +See `CHANGELOG.md`; the loader version is `vX.Y.Z` in `main.html` and `modules/module-loader.js`. + +## Licence + +MIT — see `LICENSE`. |