summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-06-20 23:21:39 +0200
committerChristian Poessinger <christian@poessinger.com>2020-06-20 23:26:39 +0200
commita20fedacdf3503369b38bd84fb4014c178a33003 (patch)
tree5ab0f75f780ef4c91db7b3b16cde68484bd493e7
parentf33c910f688e3065e40d7ab3080c83cd68b0ce94 (diff)
downloadvyos-build-a20fedacdf3503369b38bd84fb4014c178a33003.tar.gz
vyos-build-a20fedacdf3503369b38bd84fb4014c178a33003.zip
README: explain vars and packages folders in root
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4f3526eb..88767431 100644
--- a/README.md
+++ b/README.md
@@ -35,11 +35,17 @@ used for building those packages and the installation image.
There are several directories with their own purpose:
- * `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)
- * `tools/` Scripts that are used for maintainer's tasks automation and other
- purposes, but not during ISO build process
+ * `build/` Used for temporary files used for the build and for build artifacts
+ * `data/` Data required for building the ISO (e.g. boot splash/configs)
+ * `packages/` This directory has two meanings. First it can hold arbitrary *.deb
+ packages which will be embeded into the resulting ISO, but it also
+ 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