README.md

Fri, 12 Jul 2019 20:50:00 +0200

author
David Demelier <markand@malikania.fr>
date
Fri, 12 Jul 2019 20:50:00 +0200
changeset 594
3cffdd760a86
parent 553
09c120c271be
child 714
6b4ba668a43c
permissions
-rw-r--r--

vanilla: improve docs files

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
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
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
46
0468f47a45ce vanilla: reorganize base applications
David Demelier <markand@malikania.fr>
parents: 10
diff changeset
24 $ vpk install /tmp/vpk/zlib*.txz
10
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
553
09c120c271be vanilla: update README.md
David Demelier <markand@malikania.fr>
parents: 349
diff changeset
29 Check the variable `PKGOPTIONS` in the build script file, if there is one it
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
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 Specify environment variables before calling `vpk build`.
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 Example:
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 $ PULSEAUDIO=no vpk build
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
719eed6940e0 misc: add READMEs
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 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
39
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
40 Categories
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
41 ==========
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
42
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
43 Available package categories:
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
44
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
45 - *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
46 - *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
47 - *desktop*: miscellaneous desktop applications
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
48 - *dev*: development, compilers and debuggers
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
49 - *editors*: text file editors
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
50 - *emulators*: game or machine emulators
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
51 - *games*: games and toys
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
52 - *haskell*: haskell packages and interpreters
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
53 - *kde*: the plasma desktop
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
54 - *lib*: packages with only libraries
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
55 - *mate*: the mate desktop
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
56 - *misc*: miscellaneous packages
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
57 - *network*: network tools and applications
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
58 - *office*: office suites and PIM
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
59 - *perl*: perl packages and interpreters
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
60 - *python*: python packages and interpreters
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
61 - *ruby*: ruby packages and interpreters
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
62 - *system*: system administration and tools
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
63 - *tcl*: tcl packages and interpreters
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
64 - *video*: video manipulation
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
65 - *wm*: window managers
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
66 - *xfce*: the XFCE desktop
7b000befead5 vanilla: improve docs and hierarchy
David Demelier <markand@malikania.fr>
parents: 46
diff changeset
67 - *x11*: the X distribution

mercurial