diff options
author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2019-03-06 19:09:04 -0600 |
---|---|---|
committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2019-03-06 19:09:04 -0600 |
commit | efc6792152a1b5fba1165a0ff41ccf74541ca134 (patch) | |
tree | 2373942a7f5151bcb35d9b6989454c4e9f4cb64c /README.rst | |
parent | 5f911e3fa6e19a5a0c1245e1d610b8d3e7ff4914 (diff) | |
download | abuild-efc6792152a1b5fba1165a0ff41ccf74541ca134.tar.gz abuild-efc6792152a1b5fba1165a0ff41ccf74541ca134.tar.bz2 abuild-efc6792152a1b5fba1165a0ff41ccf74541ca134.tar.xz abuild-efc6792152a1b5fba1165a0ff41ccf74541ca134.zip |
Add documentation for the repository
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..3ccbe17 --- /dev/null +++ b/README.rst @@ -0,0 +1,71 @@ +======================================== + README for Adélie Linux Build Software +======================================== +:Authors: + * **A. Wilcox**, Distro Lead + * **Adélie Linux Developers and Users**, contributions +:Status: + Production +:Copyright: + © 2019 Adélie Linux Team. Mix of MIT and GPL 2 open source licences. + + + + +Introduction +============ + +This repository contains the software used to build the Adélie Linux package +set. It is used by Adélie Linux for package building to create the repository +used by Adélie's APK package manager. + + +Licenses +````````` +Most of the code in this repository is licensed GPL-2.0-only. The +``abuild-fetch`` applet is licensed under the MIT license. + + +Changes +``````` +Any changes to this repository - additions, removal, or version bumps - must +be reviewed before being pushed to the master branch. There are no exceptions +to this rule. For security-sensitive updates, contact the Security Team at +sec-bugs@adelielinux.org. + + + + +Contents +======== + +This section contains a high-level view of the contents of this repository. + + +``abuild-fetch``: Download package sources +`````````````````````````````````````````` +The ``abuild-fetch`` applet is used to download package sources from the +Internet. + + +``abuild-tar``: Archive manipulation +```````````````````````````````````` +The ``abuild-tar`` applet is used to manipulate ``tar`` files into ``APK`` +files. More on the APK file format is discussed on our wiki_. + +.. _wiki: https://wiki.adelielinux.org/wiki/APK_internals + + +``abuild``: Package building +```````````````````````````` +The ``abuild`` script is the script responsible for building packages. + + +``newapkbuild``: Package recipe creation +```````````````````````````````````````` +The ``newapkbuild`` script is used to create new package recipes, called +``APKBUILD`` files. More information can be found in the Handbook_ or the +man page installed with the ``abuild-doc`` package (``man 5 APKBUILD``). + +.. _Handbook: https://help.adelielinux.org/html/devel/ + |