diff --git a/README.md b/README.md index 599393d..274b8b8 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,45 @@
- + Aurora Logo

Aurora Rendering Engine

- A.R.E. - A High-Performance Path Tracing Library in C++ + ARE - A High-Performance Path Tracing Library in C++

- English | 中文 + English | 中文

- - License + + License - + Version - - Issues + + Issues

+ --- -## 📖 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. -## ✨ Features -- 🚀 **GPU-Accelerated Path Tracing** - Powered by OpenGL 4.3 Compute Shaders -- 🎨 **PBR Material System** - Diffuse, Metal, Dielectric materials -- 💡 **Multiple Light Types** - Point lights, Area lights, Environmental lighting -- 📦 **Static Library** - Easy integration into existing projects -- 🔧 **CMake Build System** - Cross-platform support -## 🛠️ Dependencies -A.R.E. depends on the following external libraries: -- **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 +## Overview +**Aurora Rendering Engine (ARE)** is a high-performance path tracing library developed in C++ by **NanoEra Studio**. +## Dependencies +- **OpenGL 4.3** +- **GLFW** +- **GLAD** +- **GLM** +- **stb-image** +- **spdlog** +## Quick Start ### Clone Repository ```bash -git clone https://github.com/NanoEraStudio/AuroraRenderingEngine.git -cd AuroraRenderingEngine +git clone https://github.com/NanoEra/aurora-rendering-engine.git +cd aurora-rendering-engine ``` ### Build Project ```bash @@ -53,8 +47,8 @@ mkdir build && cd build cmake .. cmake --build . ``` -## 🎮 Minimal Example: Cornell Box -The following code demonstrates how to render a classic Cornell Box scene using A.R.E.: +## Example +Here is a cornell box demo using ARE: ```cpp #include #include @@ -127,15 +121,8 @@ int main() { 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. --- +
- Built with ❤️ by NanoEra Studio + Built by NanoEra Studio
diff --git a/README_zh.md b/README_zh.md index ade461d..7b7785d 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,52 +1,44 @@
- + Aurora Logo

曙光渲染引擎

- Aurora Rendering Engine (A.R.E.)
- 一个基于 C++ 的高性能路径追踪渲染库 + Aurora Rendering Engine (ARE) - 一个基于 C++ 的高性能路径追踪渲染库

- English | 中文 + English | 中文

- + License - + Version - - Issues + + Issues

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