swarm repositories / source
aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md12
-rw-r--r--crates/memview/Cargo.toml2
-rw-r--r--crates/memview/README.md23
3 files changed, 13 insertions, 24 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..27da373
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# memview
+
+Linux-only RAM attribution TUI.
+
+Covers processes, tmpfs, shared mappings, SysV shm, and kernel counters.
+
+```bash
+cargo install --path crates/memview --locked --profile release
+memview
+```
+
+Press `?` for keys.
diff --git a/crates/memview/Cargo.toml b/crates/memview/Cargo.toml
index a834f25..3c19d79 100644
--- a/crates/memview/Cargo.toml
+++ b/crates/memview/Cargo.toml
@@ -5,7 +5,7 @@ edition.workspace = true
keywords = ["linux", "memory", "procfs", "tmpfs", "tui"]
categories = ["command-line-utilities"]
license.workspace = true
-readme = "README.md"
+readme = "../../README.md"
repository = "https://git.swarm.moe/memview"
rust-version.workspace = true
version.workspace = true
diff --git a/crates/memview/README.md b/crates/memview/README.md
deleted file mode 100644
index 3ba685a..0000000
--- a/crates/memview/README.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# memview
-
-`memview` is a Linux-only terminal UI for attributing RAM usage across the
-surfaces that usually make totals feel impossible to reconcile: processes,
-tmpfs, shared mappings, SysV shm, and kernel counters.
-
-It is intentionally not cross-platform. The tool reads Linux `/proc`, tmpfs
-mount metadata, smaps on demand, and pidfd process-control surfaces.
-
-## Install
-
-```bash
-cargo install --path crates/memview --locked --profile release
-```
-
-## Use
-
-```bash
-memview
-```
-
-The default pane is `Processes`. Press `?` inside the TUI for global and
-pane-specific controls.