bump to v0.1.0-alpha.1 (#2)

* prerelease-0.2.0

* Fix: rename .github/workflow to .github/workflows

* Fix: remove invalid cross-file dependencies

* Fix: remove duplicate categories and switch to nightly toolchain

* chore: update repository and docs url to upstream

Author: numpy1314

.github/workflows/check.yml

@@ -0,0 +1,30 @@
+name: Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: rustfmt, clippy, llvm-tools-preview
+
+      - name: Check Formatting
+        run: cargo fmt --all -- --check
+
+      - name: Check Clippy
+        run: cargo clippy --all-features -- -D warnings
+
+      - name: Check Documentation Build
+        run: cargo doc --no-deps --all-features

.github/workflows/deploy.yml

@@ -0,0 +1,29 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@nightly
+
+      - name: Build Documentation
+        run: cargo doc --no-deps --all-features
+
+      - name: Create index.html
+        run: echo '<meta http-equiv="refresh" content="0;url=axklib/index.html">' > target/doc/index.html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./target/doc

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@nightly
+
+      - name: Publish to Crates.io
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        run: cargo publish
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          generate_release_notes: true
+          prerelease: ${{ contains(github.ref, '-') }}

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@nightly
+
+      - name: Run Tests
+        run: cargo test --all-features

Cargo.lock

@@ -1,11 +1,15 @@
 [package]
 name = "axklib"
-version = "0.2.0"
+version = "0.1.0-alpha.1"
 edition = "2024"
 authors = ["周睿 <zrufo747@outlook.com>"]
+description = "Small kernel-helper abstractions used across the microkernel"
+repository = "https://github.com/arceos-hypervisor/axklib"
 license = "GPL-3.0-or-later OR Apache-2.0 OR MulanPSL-2.0"
 keywords = ["arceos", "kernel"]
 categories = ["os", "no-std"]
+readme = "README.md"
+documentation = "https://arceos-hypervisor.github.io/axklib"
 
 [dependencies]
 axerrno = "0.1"

Cargo.toml

@@ -0,0 +1,64 @@
+# axklib
+
+[![Crates.io](https://img.shields.io/crates/v/axklib.svg)](https://crates.io/crates/axklib)
+[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://numpy1314.github.io/axklib)
+[![License](https://img.shields.io/crates/l/axklib.svg)](https://github.com/numpy1314/axklib/blob/main/LICENSE)
+
+**axklib** — Small kernel-helper abstractions used across the ArceOS microkernel.
+
+## Overview
+
+This crate exposes a tiny, `no_std`-compatible trait (`Klib`) that the platform/board layer must implement. The trait provides a handful of common kernel helpers such as:
+
+- Memory mapping helpers
+- Timing utilities (busy-wait)
+- IRQ registration and enabling/disabling
+
+The implementation is typically supplied by the platform layer (e.g., `modules/axklib-impl`) and consumed by drivers and other modules.
+
+The crate also provides small convenience modules (`mem`, `time`, `irq`) that re-export the trait methods with shorter names to make call sites more ergonomic.
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+axklib = "0.2.0"
+```
+
+## Example
+
+```rust
+// 1. Map 4K of device MMIO at physical address `paddr`
+// Returns axerrno::AxResult<VirtAddr>
+let vaddr = axklib::mem::iomap(paddr, 0x1000)?;
+
+// 2. Busy-wait for 100 microseconds
+axklib::time::busy_wait(core::time::Duration::from_micros(100));
+
+// 3. Register an IRQ handler
+// Returns bool indicating success
+axklib::irq::register(32, my_irq_handler);
+
+fn my_irq_handler() {
+    // Handle interrupt...
+}
+```
+
+## License
+This project is licensed under either of
+
+- GNU General Public License, Version 3.0 or later (LICENSE-GPL
+ or https://www.gnu.org/licenses/gpl-3.0.html
+)
+
+- Apache License, Version 2.0 (LICENSE-APACHE
+ or http://www.apache.org/licenses/LICENSE-2.0
+)
+
+- Mulan Permissive Software License, Version 2.0 (LICENSE-MULAN
+ or https://license.coscl.org.cn/MulanPSL2/
+)
+
+at your option.