README: explain vars and packages folders in root

This commit is contained in:
Christian Poessinger 2020-06-20 23:21:39 +02:00
parent f33c910f68
commit a20fedacdf

View File

@ -35,11 +35,17 @@ used for building those packages and the installation image.
There are several directories with their own purpose: There are several directories with their own purpose:
* `build/` Used for temporary files used for the build and for build artifacts * `build/` Used for temporary files used for the build and for build artifacts
* `scripts/` Scripts that are used for the build process * `data/` Data required for building the ISO (e.g. boot splash/configs)
* `data/` Data required for building the ISO (e.g. boot splash/configs) * `packages/` This directory has two meanings. First it can hold arbitrary *.deb
* `tools/` Scripts that are used for maintainer's tasks automation and other packages which will be embeded into the resulting ISO, but it also
purposes, but not during ISO build process holds Jenkins Pipeline definitions for required VyOS packages.
Among other things those packages will be: Linux Kernel, FRR,
Netfiler...
* `scripts/` Scripts that are used for the build process
* `tools/` Scripts that are used for maintainer's tasks automation and other
purposes, but not during ISO build process
* `vars/` Jenkins Pipeline library for reusable functions
# Building images using Docker # Building images using Docker