From 75f756bd09f89e67d4a91ef672b557ad35ac7aa0 Mon Sep 17 00:00:00 2001
From: sisungo <sisungo@icloud.com>
Date: Tue, 18 Aug 2026 14:00:25 +0800
Subject: [PATCH] feat: add general documents

Signed-off-by: sisungo <sisungo@icloud.com>
---
 LICENSE   | 24 ++++++++++++++++++++++++
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 71 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..efb9808
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..92ee4c7
--- /dev/null
+++ b/README.md
@@ -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.
-- 
2.55.0