README.md

Fri, 22 Feb 2019 14:07:51 +0100

author
David Demelier <markand@malikania.fr>
date
Fri, 22 Feb 2019 14:07:51 +0100
changeset 10
719eed6940e0
child 46
0468f47a45ce
permissions
-rw-r--r--

misc: add READMEs

10
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 vanilla
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 =======
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 Welcome to the vanilla source tree. This directory contains scripts to build
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 precompiled packages for vanilla.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 Usage
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 =====
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 To build a script, go to the desired directory and use `vpk download` and `vpk
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 build`.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 The `vpk` tool does not handle dependencies so you will need to install them
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 manually first.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 Example with zlib:
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 $ cd lib/zlib
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 $ vpk download
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 $ vpk build
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 Then if build succeeded, you may install the package in /tmp/vpk/pkg.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 $ vpk install /tmp/vpk/pkg/zlib*.txz
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 Options
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 =======
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 If the package contains a README.options.md file, it may supports options.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 Specify environment variables before calling `vpk build`.
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 Example:
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 $ PULSEAUDIO=no vpk build
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 Note: boolean options are set using *no* and *yes* (case sensitive).

mercurial