Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rework readme file #87

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```


28 changes: 0 additions & 28 deletions Readme.txt

This file was deleted.