From 45494b4a191d78887d530ac30a90a26f4f387da8 Mon Sep 17 00:00:00 2001
From: timoxa0 <tima012007@gmail.com>
Date: Sun, 3 Nov 2024 00:26:43 +0500
Subject: [PATCH] readme: Add readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52b0701
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# mklni - Chroot helper for makelni
+
+## Installation
+1. Create a new directory
+2. Download [mklni](https://git.timoxa0.su/timoxa0/mklni/src/branch/main/mklni.sh) in that directory
+3. Allow executing mklin ```chmod +x mklni```
+4. Install chroot ```sudo ./mklni install```
+
+## Usage
+- Setup build chroot ```sudo ./mklni install```
+
+- Remove build chroot ```sudo ./mklni uninstall```
+
+- Make image ```sudo ./mklni build path/to/lnibuild```. Image will be created in same directory
+
+- Clean raw images ```sudo ./mklni -r or --cleanraw```
+
+- Clean build chroots ```sudo ./mklni -c or --cleanup```
+
+- Chroot into ```sudo ./mklni chroot```