comparison README.md @ 10:719eed6940e0

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