From 454812a93e76f304a8dc09aa5ed193a0f074643c Mon Sep 17 00:00:00 2001 From: Nikias Bassen Date: Thu, 5 Sep 2019 08:44:39 +0200 Subject: Converted README to markdown and updated links --- README | 70 --------------------------------------------------------------- README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 70 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 58f79a0..0000000 --- a/README +++ /dev/null @@ -1,70 +0,0 @@ -About -===== - -libirecovery is a cross-platform library which implements communication to -iBoot/iBSS found on Apple's iOS devices via USB. A command-line utility is also -provided. - -The software is completely open-source, the source code is released under the -terms of the LGPL 2.1. The full license text can be found in the LICENSE file. - -This is a fork of an older version from http://www.openjailbreak.org/ and is -ment to be used with idevicerestore from the libimobiledevice project. - -Requirements -============ - -Development Packages of: - libusb - libreadline - -Software: - make - autoheader - automake - autoconf - libtool - pkg-config - gcc - -Installation -============ - -To compile run: - ./autogen.sh - make - sudo make install - -Who/What/Where? -=============== - -Home: - http://www.libimobiledevice.org/ - -Code: - git clone http://git.libimobiledevice.org/libirecovery.git - -Code (Mirror): - git clone https://github.com/libimobiledevice/libirecovery.git - -Tickets: - http://github.com/libimobiledevice/libirecovery/issues - -Mailing List: - http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel - -IRC: - irc://irc.freenode.net#libimobiledevice - -Twitter: - https://twitter.com/libimobiledev - -Credits -======= - -Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. -libirecovery is an independent software library and has not been authorized, -sponsored, or otherwise approved by Apple Inc. - -README Updated on: - 2015-10-06 diff --git a/README.md b/README.md new file mode 100644 index 0000000..b8e1060 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# libirecovery + +## About + +libirecovery is a cross-platform library which implements communication to +iBoot/iBSS found on Apple's iOS devices via USB. A command-line utility is also +provided. + +The software is completely open-source, the source code is released under the +terms of the LGPL 2.1. The full license text can be found in the LICENSE file. + +This is a fork of an older version from http://www.openjailbreak.org/ and is +ment to be used with idevicerestore from the libimobiledevice project. + +## Requirements + +Development Packages of: +* libusb (Darwin: IOKit, Windows: SetupAPI) +* libreadline + +Software: +* make +* autoheader +* automake +* autoconf +* libtool +* pkg-config +* gcc or clang + +## Installation + +To compile run: +```bash +./autogen.sh +make +sudo make install +``` + +## Who/What/Where? + +* Home: https://www.libimobiledevice.org/ +* Code: `git clone https://git.libimobiledevice.org/libirecovery.git` +* Code (Mirror): `git clone https://github.com/libimobiledevice/libirecovery.git` +* Tickets: https://github.com/libimobiledevice/libirecovery/issues +* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel +* IRC: irc://irc.freenode.net#libimobiledevice +* Twitter: https://twitter.com/libimobiledev + +## Credits + +Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. +libirecovery is an independent software library and has not been authorized, +sponsored, or otherwise approved by Apple Inc. + +README Updated on: + 2019-09-05 -- cgit v1.1-32-gdbae