From c9c66a937fd4efbcd05f301586122a848877c255 Mon Sep 17 00:00:00 2001 From: mirkobrombin Date: Mon, 12 Feb 2024 11:24:04 +0100 Subject: [PATCH] cleanup --- README.md | 44 ++++++++++++++++++++------------------------ 1 file changed, 20 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index aa46f96..ce6468c 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,6 @@

Vib (Vanilla Image Builder) is a tool that streamlines the creation of container images. It achieves this by enabling users to define a recipe consisting of a sequence of modules, each specifying a particular action required to build the image. These actions may include installing dependencies or compiling source code.

- -Stato traduzione - > **Note:** This is a work in progress. @@ -24,7 +21,7 @@ labels: args: DEBIAN_FRONTEND: noninteractive runs: -- echo 'APT::Install-Recommends "0";' > /etc/apt/apt.conf.d/01norecommends + - echo 'APT::Install-Recommends "0";' > /etc/apt/apt.conf.d/01norecommends adds: rootfs.tar.gz: / modules: [] @@ -32,12 +29,11 @@ modules: [] ### Description of Fields -* `base`: a string indicating the base image to use for the container image. -* `labels`: an object containing the labels to add to the container image. -* `args`: an object containing the build arguments to add to the container image. -* `runs`: an array of strings containing the commands to run during the build process. -* `modules`: an array of objects containing the modules to add to the container image. - +- `base`: a string indicating the base image to use for the container image. +- `labels`: an object containing the labels to add to the container image. +- `args`: an object containing the build arguments to add to the container image. +- `runs`: an array of strings containing the commands to run during the build process. +- `modules`: an array of objects containing the modules to add to the container image. ## Module Structure @@ -61,20 +57,20 @@ modules: {} ### Description of Fields -* `name`: a string representing the name of the module. This will be used as the identifier for the module so it must be unique. -* `type`: a string indicating the type of module. Currently, the supported types are "apt", "cmake", "dpkg", "dpkg-buildpackage", "go", "make", "meson" and "gen-modules". -* `path`: a string indicating the path where the modules to generate are located. Only used if type is "gen-modules". -* `source`: an object containing the information necessary to retrieve the source code for the module. The fields within this object depend on the module type. - * `packages`: a string indicating the name of the package(s) to install, only used if type is "apt". - * `paths`: a list of strings indicating the path to .deb files (or just a list of prefixes to search for .deb files) when used with"dpkg" or "dpkg-buildpackage", or a list of paths to .inst files which contain a list of packages to install when used with "apt". - * `url`: a string indicating the URL to retrieve the source code, only required if source type is "tar" or "git". - * `type`: a string indicating the type of source control system, currently "tar" and "git" are supported. - * `tag`: a string indicating the git tag to use, only used if type is "git". Use either this or `branch` and `commit`. - * `branch`: a string indicating the git branch to pull from, only used if type is "git". Use either this and `commit` or `tag`. - * `commit`: a string with the commit hash to use, only used if type is "git". Passing "latest" to this field will use the most recent commmit from the branch specified above. Use either this and `branch` or `tag`. -* `buildFlags`: an array of strings indicating any additional build flags or options. Only used if type is "meson" or "go". -* `buildVars`: a collection of key-value pairs indicating any additional build variables. Only used if type is "go". -* `modules`: an array of objects containing the modules needed to build the source code. +- `name`: a string representing the name of the module. This will be used as the identifier for the module so it must be unique. +- `type`: a string indicating the type of module. Currently, the supported types are "apt", "cmake", "dpkg", "dpkg-buildpackage", "go", "make", "meson" and "gen-modules". +- `path`: a string indicating the path where the modules to generate are located. Only used if type is "gen-modules". +- `source`: an object containing the information necessary to retrieve the source code for the module. The fields within this object depend on the module type. + - `packages`: a string indicating the name of the package(s) to install, only used if type is "apt". + - `paths`: a list of strings indicating the path to .deb files (or just a list of prefixes to search for .deb files) when used with"dpkg" or "dpkg-buildpackage", or a list of paths to .inst files which contain a list of packages to install when used with "apt". + - `url`: a string indicating the URL to retrieve the source code, only required if source type is "tar" or "git". + - `type`: a string indicating the type of source control system, currently "tar" and "git" are supported. + - `tag`: a string indicating the git tag to use, only used if type is "git". Use either this or `branch` and `commit`. + - `branch`: a string indicating the git branch to pull from, only used if type is "git". Use either this and `commit` or `tag`. + - `commit`: a string with the commit hash to use, only used if type is "git". Passing "latest" to this field will use the most recent commmit from the branch specified above. Use either this and `branch` or `tag`. +- `buildFlags`: an array of strings indicating any additional build flags or options. Only used if type is "meson" or "go". +- `buildVars`: a collection of key-value pairs indicating any additional build variables. Only used if type is "go". +- `modules`: an array of objects containing the modules needed to build the source code. ## Includes