Mercurial > vanilla
comparison README.info.md @ 33:924e6892e7ec
vanilla: add README.info.md
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 26 Feb 2019 09:46:16 +0100 |
parents | |
children | e8fb94b9551d |
comparison
equal
deleted
inserted
replaced
32:f0e059497bfa | 33:924e6892e7ec |
---|---|
1 vanilla info files | |
2 ================== | |
3 | |
4 In package directories, you'll find *name.info* files. They contains metadata | |
5 information about a given package. | |
6 | |
7 The following variables are required: | |
8 | |
9 - PKGNAME: canonical package name | |
10 - PKGVERSION: package upstream version | |
11 - PKGREVISION: vanilla package revision (starts at 1) | |
12 - PKGSUMMARY: a short summary | |
13 - PKGDOWNLOAD: a space separated list of files to download | |
14 | |
15 Dependencies | |
16 ============ | |
17 | |
18 Package dependencies are filled in the *PKGDEPENDS* variables. Dependencies are | |
19 specified using the full directory name to the missing package. | |
20 | |
21 If a package is only required at build time, add the ":build" suffix. | |
22 | |
23 Example: | |
24 | |
25 ```sh | |
26 PKGDEPENDS="dev/cmake:build libzlib" | |
27 ``` | |
28 | |
29 Options | |
30 ======= | |
31 | |
32 If a package support options, specify the documentation about those in the | |
33 README file of the given package. Also add all options as a space separated list | |
34 in the *PKGOPTIONS* variable. | |
35 | |
36 Example: | |
37 | |
38 ```sh | |
39 PKGOPTIONS="PULSEAUDIO BLUETOOTH" | |
40 ``` | |
41 | |
42 Also see README.options.md for a list of predefined options. Do not write your | |
43 own if it already exists. |