Mercurial > vanilla
changeset 10:719eed6940e0
misc: add READMEs
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 22 Feb 2019 14:07:51 +0100 |
parents | 6fc9eba0423c |
children | 3080f96acd07 |
files | README.md README.options.md |
diffstat | 2 files changed, 56 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Fri Feb 22 14:07:51 2019 +0100 @@ -0,0 +1,36 @@ +vanilla +======= + +Welcome to the vanilla source tree. This directory contains scripts to build +precompiled packages for vanilla. + +Usage +===== + +To build a script, go to the desired directory and use `vpk download` and `vpk +build`. + +The `vpk` tool does not handle dependencies so you will need to install them +manually first. + +Example with zlib: + + $ cd lib/zlib + $ vpk download + $ vpk build + +Then if build succeeded, you may install the package in /tmp/vpk/pkg. + + $ vpk install /tmp/vpk/pkg/zlib*.txz + +Options +======= + +If the package contains a README.options.md file, it may supports options. +Specify environment variables before calling `vpk build`. + +Example: + + $ PULSEAUDIO=no vpk build + +Note: boolean options are set using *no* and *yes* (case sensitive).
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.options.md Fri Feb 22 14:07:51 2019 +0100 @@ -0,0 +1,20 @@ +vanilla options +=============== + +Packages may be configured using environment variables prior to building. + +Use the following predefined options before creating your own. + +- PULSEAUDIO: control PulseAudio support +- BLUETOOTH: control bluetooth support +- DEBUG: build with debug symbols +- DOCS: control documentation (what you see in /usr/share/doc) +- MAN: control manual pages +- NLS: control native language support +- DBUS: control D-Bus support +- QT5: control Qt 5 toolkit support +- GTK3: control Gtk 3 toolkit support +- PKGCONFIG: control installation of pkg-config files +- CMAKE: control installation of CMake configuration files +- ZSH: control installation of zsh completion files +- BASH: control installation of bash completion files