From 399fd183d459f65beeb3142bc184bf9e6ec0032a Mon Sep 17 00:00:00 2001 From: Arijit Basu Date: Sun, 13 Nov 2022 11:52:54 +0530 Subject: [PATCH] Update docs --- README.md | 2 ++ RELEASE.md | 24 +++++++++++++++++------- 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c3828a4..20b934c 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,8 @@ integration][15], enabling you to achieve insane terminal productivity. - [[VIDEO] XPLR: Insanely Hackable Lua File Manager ~ Brodie Robertson](https://youtu.be/MaVRtYh1IRU) +- [[Article] What is a TUI file explorer & why would you need one? ~ xplr.stck.me](https://xplr.stck.me/post/25252/What-is-a-TUI-file-explorer-why-would-you-need-one) + ## Packaging diff --git a/RELEASE.md b/RELEASE.md index 2602d4b..8f30cda 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,7 +1,17 @@ -Process -------- -- [ ] Update `Cargo.toml` version. -- [ ] Update `config.yml` version. -- [ ] Update `Config::is_compatible()` and `Config::upgrade_notification()`. -- [ ] Publish GitHub tag. -- [ ] Update Wiki and docs. +# Build + +See [install.md](./docs/en/src/install.md#build-from-source) + +Note: xplr ships with vendored luajit. If the platform can't compile this, +you need to grep out the feature "vendored" from the "mlua" dependency +specified in [Cargo.toml](./Cargo.toml), and static link luajit yourself. + +# Release + +The final binary `target/release/xplr` can be shipped with the following assets + +- [License](./LICENSE) +- [Desktop Entry](./assets/desktop/xplr.desktop) +- [Desktop Icons](./assets/icon/) +- [Offline Docs](./docs/en/src) +- [Lua Configuration Example](./src/init.lua)