axklib

Small kernel-helper abstractions used across the microkernel

English | 中文

Introduction

axklib provides Small kernel-helper abstractions used across the microkernel. It is maintained as part of the TGOSKits component set and is intended for Rust projects that integrate with ArceOS, AxVisor, or related low-level systems software.

Quick Start

Installation

Add this crate to your Cargo.toml:

[dependencies]
axklib = "0.5.0"

Run Check and Test

# Enter the crate directory
cd components/axklib

# Format code
cargo fmt --all

# Run clippy
cargo clippy --all-targets --all-features

# Run tests
cargo test --all-features

# Build documentation
cargo doc --no-deps

Integration

Example

use axklib as _;

fn main() {
    // Integrate `axklib` into your project here.
}

Documentation

Generate and view API documentation:

cargo doc --no-deps --open

Online documentation: docs.rs/axklib

Contributing

1. Fork the repository and create a branch
2. Run local format and checks
3. Run local tests relevant to this crate
4. Submit a PR and ensure CI passes

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.