diff README.md @ 1286:53cb989f05ad

misc: update markdown files
author David Demelier <markand@malikania.fr>
date Mon, 15 Nov 2021 09:26:44 +0100
parents a133976e0783
children
line wrap: on
line diff
--- a/README.md	Mon Nov 15 09:11:52 2021 +0100
+++ b/README.md	Mon Nov 15 09:26:44 2021 +0100
@@ -1,27 +1,29 @@
-Vanilla Linux
-=============
+The vanilla project
+===================
+
+Welcome to the vanilla source tree. This directory contains scripts to build
+precompiled packages for vanilla linux distribution.
 
-Welcome to the Vanilla Linux source tree. This directory contains scripts to
-build precompiled packages for Vanilla Linux.
+This source tree is usually only required for vanilla development, end users who
+just want to rebuild binary packages should use `vpk`, `vpkbuild` and rebuild
+source package from the official packages repository.
 
-This source tree is usually only required for Vanilla Linux development, end
-users who just want to rebuild binary packages should use `vpk` and rebuild
-source package from the repository.
+More information about the vanilla project into its dedicated [homepage][].
 
 Usage
 =====
 
-To build a script, go to the desired directory and use `vpk build`.
+To build a script, go to the desired directory and use `vpkbuild build`.
 
 Example with zlib:
 
 	$ cd compression/zlib
-	$ vpk download
-	$ vpk build
+	$ vpkbuild download
+	$ vpkbuild build -b
 
-Then if build succeeded, you may install the package in /tmp/vpk/pkg.
+Then if build succeeded, you may install the package in */tmp/vpk/*.
 
-	$ vpk add /tmp/vpk/zlib*.txz
+	$ vpk add /tmp/vpk/$(vpk arch)/zlib*.tar.gz
 
 Options
 =======
@@ -29,10 +31,12 @@
 Check the variable *PKGOPTIONS* in the build script file, if there is one it
 means the package is configurable with options.
 
-Specify environment variables before calling `vpk build`.
+Specify environment variables before calling `vpkbuild build`.
 
 Example:
 
-	$ PULSEAUDIO=no vpk build
+	$ PULSEAUDIO=no vpkbuild build
 
 Note: boolean options are set using *no* and *yes* (case sensitive).
+
+[homepage]: http://projects.malikania.fr/vanilla