ternaryop
/
aurora-rendering-engine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 修订README排版，修改细节

master
ternaryop8479 2026-02-16 11:54:41 +08:00
parent 7de250ec79
commit 022c15681a
2 changed files with 47 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -1,51 +1,45 @@
<div align="center"> <div align="center">
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine"> <a href="https://github.com/NanoEra/aurora-rendering-engine">
<img src="https://are.nanoera.top/res/logo/logo.png" alt="Aurora Logo" width="120" height="120"> <img src="https://are.nanoera.top/res/logo/logo.png" alt="Aurora Logo" width="120" height="120">
</a> </a>
<h1 align="center">Aurora Rendering Engine</h1> <h1 align="center">Aurora Rendering Engine</h1>
<p align="center"> <p align="center">
<strong>A.R.E.</strong> - A High-Performance Path Tracing Library in C++ <strong>ARE</strong> - A High-Performance Path Tracing Library in C++
<br/> <br/>
<br/> <br/>
English | <a href="README-zh.md">中文</a> English | <a href="README_zh.md">中文</a>
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine/blob/main/LICENSE"> <a href="https://github.com/NanoEra/aurora-rendering-engine/blob/main/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"> <img src="https://img.shields.io/badge/license-LGPL-blue.svg" alt="License">
</a> </a>
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine/releases"> <a href="https://github.com/NanoEra/aurora-rendering-engine/releases">
<img src="https://img.shields.io/badge/version-1.0.0-green.svg" alt="Version"> <img src="https://img.shields.io/badge/version-1.0.0-green.svg" alt="Version">
</a> </a>
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine/issues"> <a href="https://github.com/NanoEra/aurora-rendering-engine/issues">
<img src="https://img.shields.io/github/issues/NanoEraStudio/AuroraRenderingEngine.svg" alt="Issues"> <img src="https://img.shields.io/github/issues/NanoEra/aurora-rendering-engine.svg" alt="Issues">
</a> </a>
</p> </p>
</div> </div>
--- ---
## 📖 Overview ## Overview
**Aurora Rendering Engine (A.R.E.)** is a high-performance path tracing library developed in C++ by **NanoEra Studio**. Leveraging OpenGL 4.3 compute shaders for GPU-accelerated path tracing, A.R.E. provides a clean and intuitive API suitable for learning and researching ray tracing techniques. **Aurora Rendering Engine (ARE)** is a high-performance path tracing library developed in C++ by **NanoEra Studio**.
## ✨ Features ## Dependencies
- 🚀 **GPU-Accelerated Path Tracing** - Powered by OpenGL 4.3 Compute Shaders - **OpenGL 4.3**
- 🎨 **PBR Material System** - Diffuse, Metal, Dielectric materials - **GLFW**
- 💡 **Multiple Light Types** - Point lights, Area lights, Environmental lighting - **GLAD**
- 📦 **Static Library** - Easy integration into existing projects - **GLM**
- 🔧 **CMake Build System** - Cross-platform support - **stb-image**
## 🛠️ Dependencies - **spdlog**
A.R.E. depends on the following external libraries: ## Quick Start
- **OpenGL 4.3** - Graphics API
- **GLFW** - Window and input management
- **GLAD** - OpenGL loader
- **GLM** - Mathematics library
- **stb-image** - Image loading
- **spdlog** - Logging system
## 📦 Quick Start
### Clone Repository ### Clone Repository
```bash ```bash
git clone https://github.com/NanoEraStudio/AuroraRenderingEngine.git git clone https://github.com/NanoEra/aurora-rendering-engine.git
cd AuroraRenderingEngine cd aurora-rendering-engine
``` ```
### Build Project ### Build Project
```bash ```bash
@ -53,8 +47,8 @@ mkdir build && cd build
cmake .. cmake ..
cmake --build . cmake --build .
``` ```
## 🎮 Minimal Example: Cornell Box ## Example
The following code demonstrates how to render a classic Cornell Box scene using A.R.E.: Here is a cornell box demo using ARE:
```cpp ```cpp
#include <core/renderer.h> #include <core/renderer.h>
#include <scene/scene.h> #include <scene/scene.h>
@ -127,15 +121,8 @@ int main() {
return 0; return 0;
} }
``` ```
## 📚 Documentation
For detailed documentation, visit: [A.R.E. Documentation](https://are.nanoera.top/docs)
## 🤝 Contributing
We welcome all forms of contributions! Please check [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
Thanks to all the developers and contributors of the dependency libraries.
--- ---
<div align="center"> <div align="center">
<sub>Built with ❤️ by <a href="https://github.com/NanoEraStudio">NanoEra Studio</a></sub> <sub>Built by <a href="https://www.nanoera.top/">NanoEra Studio</a></sub>
</div> </div>

59
README_zh.md
View File

@ -1,52 +1,44 @@
<div align="center"> <div align="center">
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine"> <a href="https://github.com/NanoEra/aurora-rendering-engine">
<img src="https://are.nanoera.top/res/logo/logo.png" alt="Aurora Logo" width="120" height="120"> <img src="https://are.nanoera.top/res/logo/logo.png" alt="Aurora Logo" width="120" height="120">
</a> </a>
<h1 align="center">曙光渲染引擎</h1> <h1 align="center">曙光渲染引擎</h1>
<p align="center"> <p align="center">
<strong>Aurora Rendering Engine (A.R.E.)</strong><br/> <strong>Aurora Rendering Engine (ARE)</strong> - 一个基于 C++ 的高性能路径追踪渲染库
一个基于 C++ 的高性能路径追踪渲染库
<br/> <br/>
<br/> <br/>
<a href="README_EN.md">English</a> | 中文 <a href="README.md">English</a> | 中文
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine/blob/main/LICENSE"> <a href="https://github.com/NanoEra/aurora-rendering-engine/blob/main/LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"> <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
</a> </a>
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine/releases"> <a href="https://github.com/NanoEra/aurora-rendering-engine/releases">
<img src="https://img.shields.io/badge/version-1.0.0-green.svg" alt="Version"> <img src="https://img.shields.io/badge/version-1.0.0-green.svg" alt="Version">
</a> </a>
<a href="https://github.com/NanoEraStudio/AuroraRenderingEngine/issues"> <a href="https://github.com/NanoEra/aurora-rendering-engine/issues">
<img src="https://img.shields.io/github/issues/NanoEraStudio/AuroraRenderingEngine.svg" alt="Issues"> <img src="https://img.shields.io/github/issues/NanoEra/aurora-rendering-engine.svg" alt="Issues">
</a> </a>
</p> </p>
</div> </div>
--- ---
## 📖 简介 ## 📖 简介
曙光渲染引擎（Aurora Rendering Engine，简称 A.R.E.）是一个基于 C++ 开发的路径追踪渲染库，由 **NanoEra Studio** 开发和维护。A.R.E. 利用 OpenGL 4.3 计算着色器实现高效的 GPU 路径追踪，提供了简洁易用的 API，适合学习和研究光线追踪技术。 曙光渲染引擎（Aurora Rendering Engine，简称 ARE）是一个基于 C++ 开发的路径追踪渲染库，由 **NanoEra Studio** 开发和维护。
## ✨ 特性 ## 依赖
- 🚀 **GPU 加速路径追踪** - 基于 OpenGL 4.3 Compute Shader - **OpenGL 4.3**
- 🎨 **PBR 材质系统** - 支持漫反射、金属、电介质等材质 - **GLAD**
- 💡 **多种光源支持** - 点光源、面光源、环境光 - **GLM**
- 📦 **静态链接库** - 轻松集成到现有项目 - **stb-image**
- 🔧 **CMake 构建** - 跨平台支持 - **spdlog**
## 🛠️ 依赖项 ## 快速开始
A.R.E. 依赖以下外部库：
- **OpenGL 4.3** - 图形 API
- **GLFW** - 窗口和输入管理
- **GLAD** - OpenGL 加载器
- **GLM** - 数学库
- **stb-image** - 图像加载
- **spdlog** - 日志系统
## 📦 快速开始
### 克隆仓库 ### 克隆仓库
```bash ```bash
git clone https://github.com/NanoEraStudio/AuroraRenderingEngine.git git clone https://github.com/NanoEra/aurora-rendering-engine.git
cd AuroraRenderingEngine cd aurora-rendering-engine
``` ```
### 编译项目 ### 编译项目
```bash ```bash
@ -54,8 +46,8 @@ mkdir build && cd build
cmake .. cmake ..
cmake --build . cmake --build .
``` ```
## 🎮 极简示例：康奈尔盒子 ## 示例
以下代码展示了如何使用 A.R.E. 渲染一个经典的康奈尔盒子场景： 如下是一个Cornell Box Demo：
```cpp ```cpp
#include <core/renderer.h> #include <core/renderer.h>
#include <scene/scene.h> #include <scene/scene.h>
@ -128,16 +120,9 @@ int main() {
return 0; return 0;
} }
``` ```
## 📚 文档
详细文档请访问：[A.R.E. Documentation](https://are.nanoera.top/docs)
## 🤝 贡献指南
我们欢迎所有形式的贡献！请查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详情。
## 📄 许可证
本项目基于 MIT 许可证开源，详见 [LICENSE](LICENSE) 文件。
## 🙏 致谢
感谢所有依赖库的开发者和贡献者。
--- ---
<div align="center"> <div align="center">
<sub>Built with ❤️ by <a href="https://github.com/NanoEraStudio">NanoEra Studio</a></sub> <sub>Built by <a href="https://www.nanoera.top/">NanoEra Studio</a></sub>
</div> </div>