From f1c20b5d7d63bf0b1cc1e05aa5cf432fd6d752c2 Mon Sep 17 00:00:00 2001
From: QwertyChouskie <qwertychouskie@users.noreply.github.com>
Date: Sun, 7 Jun 2026 00:05:36 -0700
Subject: [PATCH] Rework README

- Switch to Markdown format (displays a lot nicer on GitHub)
- Make sure pkg-config is installed from the start, rather than adding a separate troubleshooting section for when it's not installed
- General improvements to grammar/formatting/etc
---
 README.md  | 25 +++++++++++++++++++++++++
 Readme.txt | 25 -------------------------
 2 files changed, 25 insertions(+), 25 deletions(-)
 create mode 100644 README.md
 delete mode 100644 Readme.txt

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0455d41
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# rkdeveloptool
+
+`rkdeveloptool` gives you a simple way to read/write rockusb devices.
+
+## Compile and install
+
+1. Install the necessary packages:
+```bash
+sudo apt-get install pkg-config autoconf libudev-dev libusb-1.0-0-dev
+```
+2. `cd` into the root folder of rkdeveloptool
+3. `./autogen.sh`
+4. `./configure`
+5. `make`
+
+## Usage
+
+Run `rkdeveloptool -h` for the full list of commands.
+
+Example of downloading `kernel.img`:
+```bash
+sudo ./rkdeveloptool db RKXXLoader.bin       # Download usbplug to device
+sudo ./rkdeveloptool wl 0x8000 kernel.img    # 0x8000 is base of the kernel partition, unit is in sectors
+sudo ./rkdeveloptool rd                      # Reset device
+```
diff --git a/Readme.txt b/Readme.txt
deleted file mode 100644
index 2561f1e..0000000
--- a/Readme.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-rkdeveloptool gives you a simple way to read/write rockusb device.let's start.
-
-compile and install
-1. install libusb and libudev
-	sudo apt-get install libudev-dev libusb-1.0-0-dev dh-autoreconf
-2. go into root of rkdeveloptool
-3. ./autogen.sh
-4. ./configure
-5. make
-
-rkdeveloptool usage,input "rkdeveloptool -h" to see
-
-example:
-1.download kernel.img
-sudo ./rkdeveloptool db RKXXLoader.bin    //download usbplug to device
-sudo ./rkdeveloptool wl 0x8000 kernel.img //0x8000 is base of kernel partition,unit is sector.
-sudo ./rkdeveloptool rd                   //reset device
-
-compile error help
-if you encounter the error like below:
-./configure: line 4269: syntax error near unexpected token `LIBUSB1,libusb-1.0'
-./configure: line 4269: `PKG_CHECK_MODULES(LIBUSB1,libusb-1.0)'
-
-You should install pkg-config libusb-1.0:
-	sudo apt-get install pkg-config libusb-1.0