Mercurial > vanilla
changeset 33:924e6892e7ec
vanilla: add README.info.md
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 26 Feb 2019 09:46:16 +0100 |
parents | f0e059497bfa |
children | e5858633b34b |
files | README.info.md |
diffstat | 1 files changed, 43 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.info.md Tue Feb 26 09:46:16 2019 +0100 @@ -0,0 +1,43 @@ +vanilla info files +================== + +In package directories, you'll find *name.info* files. They contains metadata +information about a given package. + +The following variables are required: + +- PKGNAME: canonical package name +- PKGVERSION: package upstream version +- PKGREVISION: vanilla package revision (starts at 1) +- PKGSUMMARY: a short summary +- PKGDOWNLOAD: a space separated list of files to download + +Dependencies +============ + +Package dependencies are filled in the *PKGDEPENDS* variables. Dependencies are +specified using the full directory name to the missing package. + +If a package is only required at build time, add the ":build" suffix. + +Example: + +```sh +PKGDEPENDS="dev/cmake:build libzlib" +``` + +Options +======= + +If a package support options, specify the documentation about those in the +README file of the given package. Also add all options as a space separated list +in the *PKGOPTIONS* variable. + +Example: + +```sh +PKGOPTIONS="PULSEAUDIO BLUETOOTH" +``` + +Also see README.options.md for a list of predefined options. Do not write your +own if it already exists.