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

1. Clone repo

git clone --recursive https://github.com/Starry-OS/StarryOS.git
cd StarryOS

Or if you have already cloned it without --recursive option:

cd StarryOS
git submodule update --init --recursive

2. Install Prerequisites

A. Using Docker

We provide a prebuilt Docker image with all dependencies installed.

For users in mainland China, you can use the following image which includes optimizations like Debian packages mirrors and crates.io mirrors:

docker pull docker.cnb.cool/starry-os/arceos-build
docker run -it --rm -v $(pwd):/workspace -w /workspace docker.cnb.cool/starry-os/arceos-build

For other users, you can use the image hosted on GitHub Container Registry:

docker pull ghcr.io/arceos-org/arceos-build
docker run -it --rm -v $(pwd):/workspace -w /workspace ghcr.io/arceos-org/arceos-build

Note: The --rm flag will destroy the container instance upon exit. Any changes made inside the container (outside of the mounted /workspace volume) will be lost. Please refer to the Docker documentation for more advanced usage.

B. Manual Setup

i. Install System Dependencies

This step may vary depending on your operating system. Here is an example based on Debian:

sudo apt update
sudo apt install -y build-essential cmake clang qemu-system

Note: Running on LoongArch64 requires QEMU 10. If the QEMU version in your Linux distribution is too old (e.g. Ubuntu), consider building QEMU from source.

ii. Install Musl Toolchain

1. Download files from setup-musl releases

2. Extract to some path, for example /opt/riscv64-linux-musl-cross

3. Add bin folder to PATH, for example:

   export PATH=/opt/riscv64-linux-musl-cross/bin:$PATH
   

iii. Setup Rust toolchain

# Install rustup from https://rustup.rs or using your system package manager

# Automatically download components via rustup
cd StarryOS
cargo -V

3. 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.

4. 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.