summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorDoan Luu Duc Tai <doan@luuduct.ai>2026-10-31 12:25:30 -0500
committerDoan Luu Duc Tai <doan@luuduct.ai>2026-10-31 12:25:30 -0500
commit9139398d465f5899cc31bc4cdd54daa7392ca550 (patch)
treedebf0b15a969e8c64e3b3597f4eb7953b7f047e1 /README.txt
parentef61fc5aca6eca613a055c507a060b70bd537a37 (diff)
Migrate browser code and tests to strict TypeScript
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.txt b/README.txt
index 2ff1cf6..bfe5bab 100644
--- a/README.txt
+++ b/README.txt
@@ -22,7 +22,8 @@ STACK
GETTING STARTED
Install Rust through rustup, Podman, Git, and GnuPG on a Linux development
- machine. Chat builds also need a GCC-compatible C compiler, Linux UAPI
+ machine, plus Node >=22.18.0 and npm for the TypeScript browser build.
+ Chat builds also need a GCC-compatible C compiler, Linux UAPI
headers, libclang, pkg-config, make, Perl, curl, tar, and OpenSSL 3.5+
development libraries for native workspace checks. The pinned toolchain
includes rustfmt, Clippy, and the static x86_64 Linux target.
@@ -53,7 +54,8 @@ DEVELOPMENT AND PRODUCTION
backup recipients, and secret-setting names. See docs/CONFIGURATION.txt.
var/ contains private persistent data, container storage, temporary work,
and exports. Generated TLS private keys are runtime data under var/.
- .env, var/, .tools/, target/, bin/, and dist/ are excluded from Git.
+ .env, var/, .tools/, target/, bin/, dist/, and node_modules/ are excluded
+ from Git. Browser code and tests are TypeScript; see docs/TYPESCRIPT.txt.
The four services are Caddy, cgit, SearXNG, and the Rust chat server. The management
command is Rust. SearXNG and the cgit container's upstream supervisor retain
@@ -61,7 +63,7 @@ DEVELOPMENT AND PRODUCTION
Build and test on the development machine. Deploy prebuilt release
archives. The production host needs Podman, Git, and GnuPG, but no Rust
- toolchain or Cargo.
+ toolchain, Cargo, Node, npm, or TypeScript.
CHECKS AND LICENSES
@@ -70,7 +72,9 @@ CHECKS AND LICENSES
cargo stack check
cargo stack release
- Check runs formatting, Clippy, tests, rustdoc, cargo-deny, and cargo-about.
+ Check builds and checks TypeScript, then runs Rust formatting, Clippy, tests,
+ rustdoc, cargo-deny, and cargo-about. npm development dependencies are pinned
+ in package-lock.json; run npm audit to check their advisories.
THIRD-PARTY-LICENSES.html is generated from Cargo.lock and about.hbs.
Human-readable license headings use GNU's names. SPDX identifiers and
original third-party legal texts retain their exact spelling.