Starry OS

An experimental monolithic OS based on ArceOS

Supported Architectures

• RISC-V 64
• LoongArch64
• AArch64
• x86_64 (work in progress)

Features

TODO

Quick Start

Build with Yocto (Recommended)

StarryOS is designed to be built with the Yocto Project for full embedded Linux system integration.

1. Sync repositories

mkdir -p starryos-workspace && cd starryos-workspace

repo init -u https://github.com/kylin-x-kernel/starryos-manifest -m base.xml

repo sync -j$(nproc)

2. Build with Yocto

cd starryos-workspace
source poky/oe-init-build-env build

# Build StarryOS kernel
bitbake starry

# Or build complete system image
bitbake starry-minimal-image

# Or runqemu for starryos
runqemu starry-minimal-image nographic

Note: If the local.conf.sample template in meta-starry/conf/ has been updated, you may need to manually merge the changes into your build/conf/local.conf

3. Daily development

# Sync all repositories to latest commits on their branches (recommended)
repo sync -c

# Sync all repositories (fetches all branches, slower)
repo sync

# Sync specific repository only
repo sync StarryOS
repo sync arceos

# View status of all repositories
repo status

# View current branches
repo branches

more details in Developer.md

Standalone Build

If you need to quickly test without Yocto, you can use the standalone build:

1. Install dependencies

# Rust toolchain
rustup target add aarch64-unknown-none-softfloat

# QEMU (Debian/Ubuntu)
sudo apt install qemu-system

# Musl toolchain (optional, for userspace programs)
# Download from https://github.com/arceos-org/setup-musl/releases

2. Prepare rootfs

# Default target: riscv64
make rootfs
# Explicit target
make ARCH=riscv64 rootfs
make ARCH=loongarch64 rootfs

This will download rootfs image from Starry-OS/rootfs and set up the disk file for running on QEMU.

3. Build and run on QEMU

# Default target: riscv64
make build
# Explicit target
make ARCH=riscv64 build
make ARCH=loongarch64 build

# Run on QEMU (also rebuilds if necessary)
make ARCH=riscv64 run
make ARCH=loongarch64 run

Note:

1. Binary dependencies will be automatically built during make build.
2. You don't have to rerun build every time. run automatically rebuilds if necessary.
3. The disk file will not be reset between each run. As a result, if you want to switch to another architecture, you must run make rootfs with the new architecture before make run.

What next?

You can check out the GUI guide to set up a graphical environment, or explore other documentation in this folder.

If you're interested in contributing to the project, please see our Contributing Guide.

See more build options in the Makefile.

License

This project is now released under the Apache License 2.0. All modifications and new contributions in our project are distributed under the same license. See the LICENSE and NOTICE files for details.