summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Nikias Bassen2019-06-21 21:30:08 +0200
committerGravatar Nikias Bassen2019-06-21 21:30:08 +0200
commitaa014c43a7dccd519c0c89605711906b30b98888 (patch)
treef847678b79df1a4f84ad450783ef26d46621cea5
parentddba0b5efbcab483e80be10130c5c797f9ac8d08 (diff)
downloadlibimobiledevice-aa014c43a7dccd519c0c89605711906b30b98888.tar.gz
libimobiledevice-aa014c43a7dccd519c0c89605711906b30b98888.tar.bz2
Converted README to markdown and updated links
-rw-r--r--README79
-rw-r--r--README.md68
2 files changed, 68 insertions, 79 deletions
diff --git a/README b/README
deleted file mode 100644
index efc09c0..0000000
--- a/README
+++ /dev/null
@@ -1,79 +0,0 @@
1About
2=====
3
4A library to communicate with services of Apple iOS devices using native
5protocols.
6
7Requirements
8============
9
10Development Packages of:
11 OpenSSL or GnuTLS
12 libplist
13 libusbmuxd
14
15Software:
16 usbmuxd
17 make
18 autoheader
19 automake
20 autoconf
21 libtool
22 pkg-config
23 gcc or clang
24
25Optional:
26 cython (Python bindings)
27 doxygen (Documentation)
28
29Installation
30============
31
32To compile run:
33 ./autogen.sh
34 make
35 sudo make install
36
37If you require a custom prefix or other option being passed to ./configure
38you can pass them directly to ./autogen.sh like this:
39 ./autogen.sh --prefix=/opt/local --enable-debug-code
40 make
41 sudo make install
42
43By default, OpenSSL will be used. If you prefer GnuTLS, configure with
44 --disable-openssl like this:
45 ./autogen.sh --disable-openssl
46
47Who/What/Where?
48===============
49
50Home:
51 http://www.libimobiledevice.org/
52
53Code:
54 git clone http://git.libimobiledevice.org/libimobiledevice.git
55
56Code (Mirror):
57 git clone https://github.com/libimobiledevice/libimobiledevice.git
58
59Tickets:
60 https://github.com/libimobiledevice/libimobiledevice/issues
61
62Mailing List:
63 http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
64
65IRC:
66 irc://irc.freenode.net#libimobiledevice
67
68Twitter:
69 https://twitter.com/libimobiledev
70
71Credits
72=======
73
74Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
75libimobiledevice is an independent software library and has not been
76authorized, sponsored, or otherwise approved by Apple Inc.
77
78README Updated on:
79 2017-04-28
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f9493c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,68 @@
1# libimobiledevice
2
3## About
4
5A library to communicate with services of Apple iOS devices using native
6protocols.
7
8## Requirements
9
10Development Packages of:
11* OpenSSL or GnuTLS
12* libplist
13* libusbmuxd
14
15Software:
16* usbmuxd (OSS or Apple's version)
17* make
18* autoheader
19* automake
20* autoconf
21* libtool
22* pkg-config
23* gcc or clang
24
25Optional:
26* cython (Python bindings)
27* doxygen (Documentation)
28
29## Installation
30
31To compile run:
32```bash
33./autogen.sh
34make
35sudo make install
36```
37
38If you require a custom prefix or other option being passed to `./configure`
39you can pass them directly to `./autogen.sh` like this:
40```bash
41./autogen.sh --prefix=/opt/local --enable-debug-code
42make
43sudo make install
44```
45
46By default, OpenSSL will be used. If you prefer GnuTLS, configure with
47`--disable-openssl` like this:
48```bash
49./autogen.sh --disable-openssl
50```
51
52## Who/What/Where?
53
54* Home: https://www.libimobiledevice.org/
55* Code: `git clone https://git.libimobiledevice.org/libimobiledevice.git`
56* Code (Mirror): `git clone https://github.com/libimobiledevice/libimobiledevice.git`
57* Tickets: https://github.com/libimobiledevice/libimobiledevice/issues
58* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
59* IRC: irc://irc.freenode.net#libimobiledevice
60* Twitter: https://twitter.com/libimobiledev
61
62## Credits
63
64Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
65libimobiledevice is an independent software library and has not been
66authorized, sponsored, or otherwise approved by Apple Inc.
67
68README Updated on: 2019-06-21