From 4c585ad54388285500fd18a6aaa516894e0f2c16 Mon Sep 17 00:00:00 2001 From: davidovski Date: Wed, 4 May 2022 23:28:13 +0100 Subject: added xcatclock --- README.md | 40 ++++++++++++++++++++++++++++++++++++---- 1 file changed, 36 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9edfc3e..0508dab 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,37 @@ -# xibuild scripts for the official xilinux repositories +# XiLinux buildfiles + +## Layout +- /repo + + repos full of packages +- /auto + + extra scripts to aid with automating package maintenance + +## How to write a buildfile + +packages are stored within folders inside their corresponding repo, for example the xipkg package is inside `/repo/xi/xipkg` + +Each package folder contains .xibuild files which desribe the packages that are to be built + +If there are multiple xibuild files in one package folder, then the one named after that folder will always be executed first. These additional xibuild files will inherit all of the variables defined in the main xibuild file, though functions will not be inherited. This means that, for example, the main package can build the main project and its files, and then subpackages can only implement the packaging of extra files. + +Other files may be placed within the folder which can be referenced within the .xbuilds. These should only be copied if they are linked in `$ADDITIONAL` + +### xibuild attributes + +A xibuild file can implement a number of different attributes that will be used within or later when describing the package + +- `NAME`: the name of the package, optional +- `DESC`: description of the package contents +- `DEPS`: other packages that this package depends on +- `MAKE_DEPS`: other packages required to build this package +- `PKG_VER`: the version of the package +- `SOURCE`: the external resource to be downloaded and unpacked, typically a tar.gz of the sourcecode +- `ADDITIONAL`: extra files that will be included, can be external or local + +### xibuild constants + +These are constants that will be passed to the xibuild environment when building the package +- `$PKG_DEST`: the output location that the package's contents should be written to +- `$BUILD_ROOT`: the path of the build root + -Contains build scripts for the following repos: -- core -- extra -- cgit v1.2.1