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