Mercurial > vanilla
annotate README.md @ 902:a133976e0783
vanilla: remove all origins, closes #2203
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 26 Aug 2019 12:14:53 +0200 |
parents | 6b4ba668a43c |
children | 53cb989f05ad |
rev | line source |
---|---|
594
3cffdd760a86
vanilla: improve docs files
David Demelier <markand@malikania.fr>
parents:
553
diff
changeset
|
1 Vanilla Linux |
3cffdd760a86
vanilla: improve docs files
David Demelier <markand@malikania.fr>
parents:
553
diff
changeset
|
2 ============= |
10 | 3 |
594
3cffdd760a86
vanilla: improve docs files
David Demelier <markand@malikania.fr>
parents:
553
diff
changeset
|
4 Welcome to the Vanilla Linux source tree. This directory contains scripts to |
3cffdd760a86
vanilla: improve docs files
David Demelier <markand@malikania.fr>
parents:
553
diff
changeset
|
5 build precompiled packages for Vanilla Linux. |
10 | 6 |
902
a133976e0783
vanilla: remove all origins, closes #2203
David Demelier <markand@malikania.fr>
parents:
714
diff
changeset
|
7 This source tree is usually only required for Vanilla Linux development, end |
a133976e0783
vanilla: remove all origins, closes #2203
David Demelier <markand@malikania.fr>
parents:
714
diff
changeset
|
8 users who just want to rebuild binary packages should use `vpk` and rebuild |
a133976e0783
vanilla: remove all origins, closes #2203
David Demelier <markand@malikania.fr>
parents:
714
diff
changeset
|
9 source package from the repository. |
a133976e0783
vanilla: remove all origins, closes #2203
David Demelier <markand@malikania.fr>
parents:
714
diff
changeset
|
10 |
10 | 11 Usage |
12 ===== | |
13 | |
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
594
diff
changeset
|
14 To build a script, go to the desired directory and use `vpk build`. |
10 | 15 |
16 Example with zlib: | |
17 | |
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
594
diff
changeset
|
18 $ cd compression/zlib |
10 | 19 $ vpk download |
20 $ vpk build | |
21 | |
22 Then if build succeeded, you may install the package in /tmp/vpk/pkg. | |
23 | |
902
a133976e0783
vanilla: remove all origins, closes #2203
David Demelier <markand@malikania.fr>
parents:
714
diff
changeset
|
24 $ vpk add /tmp/vpk/zlib*.txz |
10 | 25 |
26 Options | |
27 ======= | |
28 | |
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
594
diff
changeset
|
29 Check the variable *PKGOPTIONS* in the build script file, if there is one it |
553
09c120c271be
vanilla: update README.md
David Demelier <markand@malikania.fr>
parents:
349
diff
changeset
|
30 means the package is configurable with options. |
09c120c271be
vanilla: update README.md
David Demelier <markand@malikania.fr>
parents:
349
diff
changeset
|
31 |
10 | 32 Specify environment variables before calling `vpk build`. |
33 | |
34 Example: | |
35 | |
902
a133976e0783
vanilla: remove all origins, closes #2203
David Demelier <markand@malikania.fr>
parents:
714
diff
changeset
|
36 $ PULSEAUDIO=no vpk build |
10 | 37 |
38 Note: boolean options are set using *no* and *yes* (case sensitive). |