Mercurial > vanilla
annotate 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 |
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 |
7 Usage | |
8 ===== | |
9 | |
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
594
diff
changeset
|
10 To build a script, go to the desired directory and use `vpk build`. |
10 | 11 |
12 Example with zlib: | |
13 | |
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
594
diff
changeset
|
14 $ cd compression/zlib |
10 | 15 $ vpk download |
16 $ vpk build | |
17 | |
18 Then if build succeeded, you may install the package in /tmp/vpk/pkg. | |
19 | |
46
0468f47a45ce
vanilla: reorganize base applications
David Demelier <markand@malikania.fr>
parents:
10
diff
changeset
|
20 $ vpk install /tmp/vpk/zlib*.txz |
10 | 21 |
22 Options | |
23 ======= | |
24 | |
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
594
diff
changeset
|
25 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
|
26 means the package is configurable with options. |
09c120c271be
vanilla: update README.md
David Demelier <markand@malikania.fr>
parents:
349
diff
changeset
|
27 |
10 | 28 Specify environment variables before calling `vpk build`. |
29 | |
30 Example: | |
31 | |
32 $ PULSEAUDIO=no vpk build | |
33 | |
34 Note: boolean options are set using *no* and *yes* (case sensitive). | |
349
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
35 |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
36 Categories |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
37 ========== |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
38 |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
39 Available package categories: |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
40 |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
41 - *audio*: everything related to audio from music player to editors |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
42 - *core*: packages that are usually installed in a minimal system |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
43 - *desktop*: miscellaneous desktop applications |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
44 - *dev*: development, compilers and debuggers |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
45 - *editors*: text file editors |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
46 - *emulators*: game or machine emulators |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
47 - *games*: games and toys |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
48 - *haskell*: haskell packages and interpreters |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
49 - *kde*: the plasma desktop |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
50 - *lib*: packages with only libraries |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
51 - *mate*: the mate desktop |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
52 - *misc*: miscellaneous packages |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
53 - *network*: network tools and applications |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
54 - *office*: office suites and PIM |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
55 - *perl*: perl packages and interpreters |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
56 - *python*: python packages and interpreters |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
57 - *ruby*: ruby packages and interpreters |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
58 - *system*: system administration and tools |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
59 - *tcl*: tcl packages and interpreters |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
60 - *video*: video manipulation |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
61 - *wm*: window managers |
714
6b4ba668a43c
vanilla: update documentation
David Demelier <markand@malikania.fr>
parents:
594
diff
changeset
|
62 - *www*: web libraries and tools |
349
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
63 - *xfce*: the XFCE desktop |
7b000befead5
vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents:
46
diff
changeset
|
64 - *x11*: the X distribution |