Commit a9e684c1 authored by Martin Szulecki's avatar Martin Szulecki

Improve README.md with feature, installation and usage sections

parent c1484998
# libplist # libplist
## About *A small portable C library to handle Apple Property List files in binary or XML
format.*
A small portable C library to handle Apple Property List files in binary or XML. ## Features
## Requirements The project provides an interface to read and write plist files in binary or
XML format alongside a command-line utility named `plistutil`.
Software: - **Formats:** Supports binary and XML format
* make - **Utility:** Provides a `plistutil` utility for the command-line
* autoheader - **Python:** Provides Cython based bindings for Python
* automake - **Tested:** Uses fuzzing and data compliance tests
* autoconf - **Efficient:** Lean library with performance and resources in mind
* libtool
* pkg-config
* gcc or clang
Optional: ## Installation / Getting started
* cython (Python bindings)
* doxygen (Documentation)
## Installation ### Debian / Ubuntu Linux
To compile run: First install all required dependencies and build tools:
```bash ```shell
sudo apt-get install \
build-essential \
checkinstall \
git \
autoconf \
automake \
libtool-bin
```
If you want to optionally build the documentation or Python bindings use:
```shell
sudo apt-get install \
doxygen \
cython
```
Then clone the actual project repository:
```shell
git clone https://github.com/libimobiledevice/libplist.git
cd libplist
```
Now you can build and install it:
```shell
./autogen.sh ./autogen.sh
make make
sudo make install sudo make install
``` ```
If you require a custom prefix or other option being passed to `./configure` ## Usage
you can pass them directly to `./autogen.sh` like this:
```bash Then simply run:
./autogen.sh --prefix=/opt/local --without-cython ```shell
make plistutil -i foobar.plist -o output.plist
sudo make install
``` ```
## Who/What/Where? This converts the `foobar.plist` file to the opposite format, e.g. binary to
XML or vice versa, and outputs it to the `output.plist` file.
Please consult the usage information or manual page for a full documentation of
available command line options:
```shell
plistutil --help
man plistutil
```
* Home: https://libimobiledevice.org/ ## Links
* Code: `git clone https://git.libimobiledevice.org/libplist.git`
* Code (Mirror): `git clone https://github.com/libimobiledevice/libplist.git` * Homepage: https://libimobiledevice.org/
* Tickets: https://github.com/libimobiledevice/libplist/issues * Repository: https://git.libimobiledevice.org/libplist.git
* Repository (Mirror): https://github.com/libimobiledevice/libplist.git
* Issue Tracker: https://github.com/libimobiledevice/libplist/issues
* Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel * Mailing List: https://lists.libimobiledevice.org/mailman/listinfo/libimobiledevice-devel
* Twitter: https://twitter.com/libimobiledev * Twitter: https://twitter.com/libimobiledev
## License
This project is licensed under the [GNU Lesser General Public License v2.1](https://www.gnu.org/licenses/lgpl-2.1.en.html),
also included in the repository in the `COPYING` file.
## Credits ## Credits
Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc. Apple, iPhone, iPod, and iPod Touch are trademarks of Apple Inc.
libplist is an independent software library and has not been This project is an independent software library and has not been authorized,
authorized, sponsored, or otherwise approved by Apple Inc. sponsored, or otherwise approved by Apple Inc.
README Updated on: 2020-06-08 README Updated on: 2020-06-12
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment