Repository navigation
Release v1.0.0: Initial stable release
Pre-release
Pre-release
clangd-kernel-helper v1.0.0
🎉 首个稳定版本发布! | First Stable Release!
为 Linux 内核驱动开发带来现代化 IDE 体验。
Modern IDE features for Linux kernel driver development.
✨ 核心功能 | Key Features
代码智能 | Code Intelligence
- 🚀 跳转定义 (F12) | Go to Definition
- 🔍 智能补全 | Smart Completion
- 🔎 查找引用 | Find References
- 📖 悬停文档 | Hover Documentation
⚠️ 实时诊断 | Real-time Diagnostics
内核开发支持 | Kernel Development
- ✅ 自动提取 947+ CONFIG_* 宏 | Extract 947+ CONFIG_* macros
- ✅ 智能扫描内核源文件 | Smart kernel source scanning
- ✅ 自动生成 compile_commands.json | Auto-generate compile_commands.json
- ✅ 支持多架构 (ARM/ARM64/x86_64/RISC-V) | Multi-architecture support
- ✅ 交叉编译器支持 | Cross-compiler support
开发体验 | Developer Experience
- 📚 双语文档 (中文+英文) | Bilingual docs (EN+CN)
- 🎯 8 个实际使用示例 | 8 real-world examples
- 🚀 快速设置脚本 | Quick setup script
- 🤖 GitHub 模板和 CI/CD | Templates & CI/CD
📦 快速开始 | Quick Start
# 克隆仓库 | Clone repository
git clone https://github.com/TbusOS/clangd-kernel-helper.git
cd clangd-kernel-helper
# 快速设置 | Quick setup
./scripts/setup.sh
# 生成编译数据库 | Generate compile_commands.json
./clangd-kernel-helper --with-kernel📖 文档 | Documentation
- 📘 English README - Complete documentation
- 📗 中文文档 - 完整中文文档
- 📙 Examples - 8 usage scenarios
- 📕 Contributing - How to contribute
🎯 使用场景 | Use Cases
适用于 | Perfect for:
- 🔧 内核驱动开发者 | Kernel driver developers
- 📱 嵌入式工程师 | Embedded engineers
- 🎓 操作系统课程学生 | OS course students
- 👨💻 固件开发者 | Firmware developers
🆚 效果对比 | Before vs After
之前 | Before
- ❌ 无代码补全 | No completion
- ❌ 无法跳转定义 | Can't jump to definition
- ❌ 无错误检查 | No error checking
- ❌ 开发效率低 | Slow development
之后 | After
- ✅ 智能补全 | Smart completion
- ✅ 即时跳转 | Instant jump
- ✅ 实时检查 | Real-time checking
- ✅ 高效开发 | Fast development
📊 项目统计 | Project Stats
- 代码行数 | Lines: 3,500+
- 文档行数 | Docs: 2,800+
- 示例数 | Examples: 8 scenarios
- 支持语言 | Languages: 2 (EN/CN)
- 架构支持 | Architectures: ARM/ARM64/x86_64/RISC-V
- 许可证 | License: GPL-2.0
🌍 国际化 | International
- 🇺🇸 Complete English documentation
- 🇨🇳 完整中文文档
- 🌐 欢迎更多语言翻译 | More translations welcome
🤝 参与贡献 | Contributing
欢迎贡献!| Contributions welcome!
- 🐛 报告 Bug | Report bugs
- 💡 提出建议 | Suggest features
- 📖 改进文档 | Improve docs
- 🔧 提交代码 | Submit code
详见 | See CONTRIBUTING.md
📄 许可证 | License
GPL-2.0 - 与 Linux 内核保持一致 | Same as Linux kernel
💝 支持项目 | Support
如果这个项目对你有帮助:| If this project helps you:
- ⭐ 给个 Star | Star the repo
- 🔀 Fork 并贡献 | Fork and contribute
- 📢 分享给其他开发者 | Share with others
- 💬 提供反馈 | Provide feedback
用 ❤️ 为全球内核开发者打造 | Made with ❤️ for kernel developers worldwide
感谢使用 clangd-kernel-helper! 🎉 | Thank you for using clangd-kernel-helper! 🎉