README.md

   1 AOSC OS ABBS Tree
   2 =================
   3
   4 The AOSC OS ABBS Tree contains build configurations and scripts
   5 for all packages made available in the official AOSC OS
   6 [repository](https://repo.aosc.io), organised in a tree-like fashion. The "Tree"
   7 is split into three main classes and various sub-categories:
   8
   9 - `core-*` contains components of the [AOSC OS Core](README.CORE.md).
  10 - `app-*` contains applications.
  11 - `desktop-*` contains desktop environments and their supporting libraries.
  12 - `lang-*` contains programming language support stacks.
  13 - `meta-*` contains meta packages (`*-base`).
  14 - `runtime-*` contains runtime libraries and data.
  15
  16 Branches
  17 --------
  18
  19 The ABBS Tree is maintained in a multi-branch fashion, for more information,
  20 please refer to the [AOSC OS Maintenance Guidelines](https://wiki.aosc.io/developer/packaging/topic-based-maintenance-guideline).
  21
  22 Groups
  23 ------
  24
  25 When using [ACBS](https://github.com/AOSC-Dev/acbs) (Autobuild CI Build System),
  26 it is possible to build a series of packages with a single command. This is
  27 achieved by the "groups" defined in the `groups/` directory, with files defining
  28 a list of packages to build.
  29
  30 Notes for developers on Windows
  31 -------------------------------
  32
  33 Currently, this repository cannot be checked out on Windows, since there are
  34 backslashes (`\`) in file names, specifically required by [systemd.mount](https://www.freedesktop.org/software/systemd/man/latest/systemd.mount.html#Description)
  35 for [string escaping](https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html#String%20Escaping%20for%20Inclusion%20in%20Unit%20Names),
  36 which is [not a valid Windows file name](https://learn.microsoft.com/windows/win32/fileio/naming-a-file#naming-conventions).
  37 Notebly, repository checkout will also fail in MinGW or Cygwin environments
  38 for the same reason. We recommend using Windows Subsystem for Linux (WSL) to
  39 work on this repository. In case you missed it, AOSC OS on WSL is available
  40 [on Microsoft Store](https://www.microsoft.com/store/apps/9NMDF21NV65Z)!
  41
  42 Further Readings
  43 ----------------
  44
  45 - [Intro to Package Maintenance](https://wiki.aosc.io/developer/packaging/basics)
  46 - [AOSC OS Package Styling Manual](https://wiki.aosc.io/developer/packaging/package-styling-manual)
  47
  48 Useful Links
  49 ------------
  50
  51 - [AOSC OS Packages](https://packages.aosc.io/)
  52 - [AOSC OS Packages, QA Information](https://packages.aosc.io/qa/)
  53     - [List of Package Issue Codes](https://wiki.aosc.io/developer/packaging/qa-issue-codes)
  54 - [AOSC Buildbot Information](https://wiki.aosc.io/developer/infrastructure/buildbots)
  55
  56 Need Help?
  57 ----------
  58
  59 Please report any build-time and run-time issues using our
  60 [issues](https://github.com/AOSC-Dev/aosc-os-abbs/issues) page.