summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README73
1 files changed, 60 insertions, 13 deletions
diff --git a/README b/README
index 3c0c8a6..58f79a0 100644
--- a/README
+++ b/README
@@ -1,4 +1,5 @@
1== What is libirecovery? == 1About
2=====
2 3
3libirecovery is a cross-platform library which implements communication to 4libirecovery is a cross-platform library which implements communication to
4iBoot/iBSS found on Apple's iOS devices via USB. A command-line utility is also 5iBoot/iBSS found on Apple's iOS devices via USB. A command-line utility is also
@@ -7,17 +8,63 @@ provided.
7The software is completely open-source, the source code is released under the 8The software is completely open-source, the source code is released under the
8terms of the LGPL 2.1. The full license text can be found in the LICENSE file. 9terms of the LGPL 2.1. The full license text can be found in the LICENSE file.
9 10
10Here's its usage: 11This is a fork of an older version from http://www.openjailbreak.org/ and is
12ment to be used with idevicerestore from the libimobiledevice project.
11 13
12irecovery [args] 14Requirements
13 -v Start irecovery in verbose mode. 15============
14 -c <cmd> Send command to client.
15 -f <file> Send file to client.
16 -k [payload] Send usb exploit to client.
17 -h Show this help.
18 -r Reset client.
19 -s Start interactive shell.
20 -e <script> Executes recovery shell script.
21 16
22You can get info on the shell commands here: 17Development Packages of:
23http://code.google.com/p/chronicdev/wiki/iBootCommands 18 libusb
19 libreadline
20
21Software:
22 make
23 autoheader
24 automake
25 autoconf
26 libtool
27 pkg-config
28 gcc
29
30Installation
31============
32
33To compile run:
34 ./autogen.sh
35 make
36 sudo make install
37
38Who/What/Where?
39===============
40
41Home:
42 http://www.libimobiledevice.org/
43
44Code:
45 git clone http://git.libimobiledevice.org/libirecovery.git
46
47Code (Mirror):
48 git clone https://github.com/libimobiledevice/libirecovery.git
49
50Tickets:
51 http://github.com/libimobiledevice/libirecovery/issues
52
53Mailing List:
54 http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
55
56IRC:
57 irc://irc.freenode.net#libimobiledevice
58
59Twitter:
60 https://twitter.com/libimobiledev
61
62Credits
63=======
64
65Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
66libirecovery is an independent software library and has not been authorized,
67sponsored, or otherwise approved by Apple Inc.
68
69README Updated on:
70 2015-10-06