<h1 align="center">axvisor_api_proc</h1>
<p align="center">Procedural macros for the `axvisor_api` crate</p>
<div align="center">
[](https://crates.io/crates/axvisor_api_proc)
[](https://docs.rs/axvisor_api_proc)
[](https://www.rust-lang.org/)
[](./LICENSE)
</div>
# 介绍
`axvisor_api_proc` 提供了 Procedural macros for the `axvisor_api` crate。它是 TGOSKits 组件集合的一部分,可用于集成 ArceOS、AxVisor 及相关底层系统软件的 Rust 项目。
## 快速开始
### 添加依赖
在 `Cargo.toml` 中加入:
```toml
[dependencies]
axvisor_api_proc = "0.5.0"
```
### 检查与测试
```bash
# 进入 crate 目录
cd components/axvisor_api/axvisor_api_proc
# 代码格式化
cargo fmt --all
# 运行 clippy
cargo clippy --all-targets --all-features
# 运行测试
cargo test --all-features
# 生成文档
cargo doc --no-deps
```
## 集成方式
### 示例
```rust
use axvisor_api_proc as _;
fn main() {
// 在这里将 `axvisor_api_proc` 集成到你的项目中。
}
```
### 文档
生成并查看 API 文档:
```bash
cargo doc --no-deps --open
```
在线文档:[docs.rs/axvisor_api_proc](https://docs.rs/axvisor_api_proc)
# 贡献
1. Fork 仓库并创建分支
2. 在本地运行格式化与检查
3. 运行与该 crate 相关的测试
4. 提交 PR 并确保 CI 通过
# 许可证
本项目采用 Apache License 2.0 许可证。详情见 [LICENSE](./LICENSE)。