From b11addcde68cf51ee2178cd3bd36cf42545792f6 Mon Sep 17 00:00:00 2001 From: S4NKALP Date: Thu, 12 Mar 2026 21:37:32 +0545 Subject: [PATCH] feat(root): Add installation instructions to README New Features - Added installation guide using `just` (recommended) and `cargo`. Enhancements - Documented systemd and X11/NVIDIA tool requirements. Bug Fixes - None. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 7881b59..bc65b19 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,27 @@ Built with performance and simplicity in mind, it talks directly to your system' --- +### Installation + +**lapctl** is built with Rust. Ensure you have the [Rust toolchain](https://rustup.rs/) installed. + +#### Option 1: Using `just` (Recommended) +If you have [just](https://github.com/casey/just) installed: +```bash +just install +``` + +#### Option 2: Using `cargo` +```bash +cargo install --path . +``` + +#### Requirements +- **systemd**: For sleep inhibitor (`systemd-inhibit`) +- **X11/NVIDIA Tools**: `xrandr`, `nvidia-settings` for GPU management + +--- + ### Quick Start Guide ```bash