feat: add general documents

Signed-off-by: sisungo <[email protected]>
2026-08-18 14:00:25 +08:00
parent c1e3a8dc05
commit 75f756bd09
2 changed files with 71 additions and 0 deletions
@@ -0,0 +1,47 @@
+# SemiOS Packages
+
+This is the SemiOS source package collection.
+
+## Usage
+
+To build a package for your native target, run:
+
+```shell
+./x build <package name>
+```
+
+To cross-build a package for another target, run:
+
+```shell
+./x --target <target triple> build <package name>
+```
+
+After a package is successfully built, you can find the build artifacts
+at `./packages/<package name>/target/*.pkg`.
+
+To clean building files for a package, run:
+
+```shell
+./x clean <package name>        # Clean a package
+./x clean --all                 # Clean all packages
+```
+
+## Targets
+
+This repository is for SemiOS targets only. Other targets are not guaranteed to work.
+Currently, we support:
+
+- aarch64-semios-linux
+- riscv64-semios-linux
+- x86_64-semios-linux
+
+## Atom Builds
+
+*Atom Build* is a technology to make reproducible building environments. To build a
+package in its atom environment, run:
+
+```shell
+./x --atombuild build <package name>
+```
+
+You can use the `--atombuild` flag with other flags described above.