# About
vplugin-package is a very simple command line utility
that helps you create a VPlugin module from the files
given. You just call it from the directory of the plugin and it reads your
`metadata.toml` file to determine the final plugin.

The application conforms with the [VPlugin Plugin Format Specification](https://github.com/VPlugin/VPlugin/blob/master/spec/PluginFormat.md) version 1.0.2.

# Archive Details
The archive created does no extra compression to emphasize in the extraction speed. If looking to reduce the final archive disk size, then you should strip down your plugin implementation file (library), and try reducing the statically linked dependencies of it.

# Usage
See `vplugin-package --help` to learn how to use the application.\
Not supplying any arguments will mean the application will package only everything that VPlugin requires (As speficied in your `metadata.toml` file).

```
Usage: vplugin-package [OPTIONS]

Options:
  -c, --compile            Compile a plugin package.
  -o, --output <FILENAME>  Filename of the plugin file [default: plugin.vpl]
      --verify <FILE>      Will only verify a plugin given, not actually package it.
  -f, --extra <FILES>      Includes the files given to the final package (WIP Option, don't use) [default: None]
  -h, --help               Print help
  -V, --version            Print version
```

# License
`vplugin-package` is released and distributed under the terms of the GNU General Public License, version 3.0
For more details, refer to the [COPYING](./COPYING) file on this repository.