From cfb71c0f6c1bb3000e6741d5143d000488b5fc37 Mon Sep 17 00:00:00 2001 From: Maksim Karpovich Date: Tue, 6 Jun 2023 11:00:53 +0300 Subject: [PATCH] rework readme file --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Readme.txt | 28 --------------------- 2 files changed, 74 insertions(+), 28 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..60b5a4d --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +# General + +rkdeveloptool gives you a simple way to read/write rockusb device + +## Compile and install + +1) Install *libusb* and *libudev* +``` +sudo apt-get install libudev-dev libusb-1.0-0-dev dh-autoreconf +``` +2) Download rkdeveloptool +``` +git clone https://github.com/rockchip-linux/rkdeveloptool.git +``` +3) Go into root of rkdeveloptool +``` +cd rkdeveloptool +``` +4) Generate *aclocal.m4* +``` +aclocal +``` +5) Update the GNU Autotools build system +``` +autoreconf -i +``` +6) Generate *config.h.in* file +``` +autoheader +``` +7) Add missing auxiliary files +``` +automake --add-missing +``` +8) Prepare the project for compilation +``` +./configure +``` +9) Invoke the build process +``` +make +``` + +## Usage + +To see the help information and available options for the rkdeveloptool command input +``` +rkdeveloptool -h +``` + +## Example: + +### 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* and *libusb-1.0*: +``` +sudo apt-get install pkg-config libusb-1.0 +``` + + diff --git a/Readme.txt b/Readme.txt deleted file mode 100644 index b96ccb3..0000000 --- a/Readme.txt +++ /dev/null @@ -1,28 +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.aclocal -4.autoreconf -i -5.autoheader -5.automake --add-missing -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