summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README68
-rw-r--r--README.md55
2 files changed, 55 insertions, 68 deletions
diff --git a/README b/README
deleted file mode 100644
index 36d074a..0000000
--- a/README
+++ /dev/null
@@ -1,68 +0,0 @@
1About
2=====
3
4A small portable C library to handle Apple Property List files in binary or XML.
5
6Requirements
7============
8
9Software:
10 make
11 autoheader
12 automake
13 autoconf
14 libtool
15 pkg-config
16 gcc
17
18Optional:
19 cython (Python bindings)
20 doxygen (Documentation)
21
22Installation
23============
24
25To compile run:
26 ./autogen.sh
27 make
28 sudo make install
29
30If you require a custom prefix or other option being passed to ./configure
31you can pass them directly to ./autogen.sh like this:
32 ./autogen.sh --prefix=/opt/local --without-cython
33 make
34 sudo make install
35
36Who/What/Where?
37===============
38
39Home:
40 http://www.libimobiledevice.org/
41
42Code:
43 git clone http://git.libimobiledevice.org/libplist.git
44
45Code (Mirror):
46 git clone https://github.com/libimobiledevice/libplist.git
47
48Tickets:
49 https://github.com/libimobiledevice/libplist/issues
50
51Mailing List:
52 http://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
53
54IRC:
55 irc://irc.freenode.net#libimobiledevice
56
57Twitter:
58 https://twitter.com/libimobiledev
59
60Credits
61=======
62
63Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
64libimobiledevice is an independent software library and has not been
65authorized, sponsored, or otherwise approved by Apple Inc.
66
67README Updated on:
68 2016-11-18
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a4e0d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
1# libplist
2
3## About
4
5A small portable C library to handle Apple Property List files in binary or XML.
6
7## Requirements
8
9Software:
10* make
11* autoheader
12* automake
13* autoconf
14* libtool
15* pkg-config
16* gcc or clang
17
18Optional:
19* cython (Python bindings)
20* doxygen (Documentation)
21
22## Installation
23
24To compile run:
25```bash
26./autogen.sh
27make
28sudo make install
29```
30
31If you require a custom prefix or other option being passed to `./configure`
32you can pass them directly to `./autogen.sh` like this:
33```bash
34./autogen.sh --prefix=/opt/local --without-cython
35make
36sudo make install
37```
38
39## Who/What/Where?
40
41* Home: https://www.libimobiledevice.org/
42* Code: `git clone https://git.libimobiledevice.org/libplist.git`
43* Code (Mirror): `git clone https://github.com/libimobiledevice/libplist.git`
44* Tickets: https://github.com/libimobiledevice/libplist/issues
45* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
46* IRC: irc://irc.freenode.net#libimobiledevice
47* Twitter: https://twitter.com/libimobiledev
48
49## Credits
50
51Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
52libimobiledevice is an independent software library and has not been
53authorized, sponsored, or otherwise approved by Apple Inc.
54
55README Updated on: 2019-05-16