OSDK User Guide

Overview

OSDK (short for Operating System Development Kit) is designed to simplify the development of Rust operating systems. It aims to streamline the process by leveraging the framekernel architecture.

OSDK provides a command-line tool cargo-osdk, which facilitates project management for those developed on the framekernel architecture. cargo-osdk can be used as a subcommand of Cargo. Much like Cargo for Rust projects, cargo-osdk enables building, running, and testing projects conveniently.

Install OSDK

Requirements

Currently, OSDK only works on x86_64 ubuntu system. We will add support for more operating systems in the future.

To run a kernel developed by OSDK with QEMU, the following tools need to be installed:

  • Rust >= 1.75.0
  • cargo-binutils
  • gcc
  • qemu-system-x86_64
  • grub
  • ovmf
  • xorriso

About how to install Rust, you can refer to the official site.

cargo-binutils can be installed after Rust is installed by

cargo install cargo-binutils

Other tools can be installed by

apt install build-essential grub-efi-amd64 grub2-common \
    libpixman-1-dev mtools qemu-system-x86 ovmf xorriso

Install

cargo-osdk is published on crates.io, and can be installed by

cargo install cargo-osdk

Upgrate

If cargo-osdk is already installed, the tool can be upgraded by

cargo install --force cargo-osdk