comparison README.md @ 714:6b4ba668a43c

vanilla: update documentation
author David Demelier <markand@malikania.fr>
date Fri, 02 Aug 2019 21:20:00 +0200
parents 3cffdd760a86
children a133976e0783
comparison
equal deleted inserted replaced
713:393525a3ecc3 714:6b4ba668a43c
5 build precompiled packages for Vanilla Linux. 5 build precompiled packages for Vanilla Linux.
6 6
7 Usage 7 Usage
8 ===== 8 =====
9 9
10 To build a script, go to the desired directory and use `vpk download` and `vpk 10 To build a script, go to the desired directory and use `vpk build`.
11 build`.
12
13 The `vpk` tool does not handle dependencies so you will need to install them
14 manually first.
15 11
16 Example with zlib: 12 Example with zlib:
17 13
18 $ cd lib/zlib 14 $ cd compression/zlib
19 $ vpk download 15 $ vpk download
20 $ vpk build 16 $ vpk build
21 17
22 Then if build succeeded, you may install the package in /tmp/vpk/pkg. 18 Then if build succeeded, you may install the package in /tmp/vpk/pkg.
23 19
24 $ vpk install /tmp/vpk/zlib*.txz 20 $ vpk install /tmp/vpk/zlib*.txz
25 21
26 Options 22 Options
27 ======= 23 =======
28 24
29 Check the variable `PKGOPTIONS` in the build script file, if there is one it 25 Check the variable *PKGOPTIONS* in the build script file, if there is one it
30 means the package is configurable with options. 26 means the package is configurable with options.
31 27
32 Specify environment variables before calling `vpk build`. 28 Specify environment variables before calling `vpk build`.
33 29
34 Example: 30 Example:
61 - *ruby*: ruby packages and interpreters 57 - *ruby*: ruby packages and interpreters
62 - *system*: system administration and tools 58 - *system*: system administration and tools
63 - *tcl*: tcl packages and interpreters 59 - *tcl*: tcl packages and interpreters
64 - *video*: video manipulation 60 - *video*: video manipulation
65 - *wm*: window managers 61 - *wm*: window managers
62 - *www*: web libraries and tools
66 - *xfce*: the XFCE desktop 63 - *xfce*: the XFCE desktop
67 - *x11*: the X distribution 64 - *x11*: the X distribution