RSGL项目使用教程

1. 项目目录结构及介绍

RSGL（Riley's Simple Graphics Library）项目是一个简单易用的跨平台图形库，其目录结构如下：

RSGL/
├── .github/             # GitHub工作流程目录
│   └── workflows/       # GitHub Actions工作流文件
├── examples/            # 示例程序目录
│   ├── basics/           # 基础示例
│   │   ├── basic.c
│   │   ├── shapes.c
│   │   ├── text.c
│   │   └── textures.c
│   ├── advanced/         # 高级示例
│   │   ├── glfw.c
│   │   └── shader.c
│   └── custom_render_samples/ # 自定义渲染示例
│       ├── custom_render_gl1.c
│       ├── custom_render_template.c
│       └── custom_render_template.h
├── LICENSE              # 许可证文件
├── Makefile             # 编译文件
├── README.md            # 项目说明文件
├── RSGL.h               # RSGL主头文件
├── RSGL_gl.h            # RSGL OpenGL渲染头文件
├── RSGL-Architecture.png # RSGL架构图
├── RSGL_logo.png        # RSGL标志
├── TODO                 # 待办事项文件
└── compile_flags.txt    # 编译标志文件

• .github/: 包含GitHub Actions的工作流文件，用于自动化项目的一些流程。
• examples/: 包含了使用RSGL的示例程序，分为基础示例和高级示例。
• LICENSE: 项目的许可证文件，本项目采用Zlib许可证。
• Makefile: 用于编译RSGL的Makefile文件。
• README.md: 项目的说明文档，介绍了RSGL的基本信息和如何使用。
• RSGL.h: RSGL的主头文件，包含了所有的功能和定义。
• RSGL_gl.h: RSGL的OpenGL渲染头文件，用于OpenGL渲染相关的功能。
• 其他文件包括项目架构图、项目标志、待办事项和编译标志文件。

2. 项目的启动文件介绍

项目的启动文件位于examples/basics/basic.c，这是一个基础的示例程序，展示了如何使用RSGL创建窗口、绘制图形和处理窗口事件。

以下是basic.c的简化代码结构：

#define RSGL_IMPLEMENTATION
#include "RSGL.h"
// 包含图形后端头文件，例如RSGL_gl.h

int main() {
    // 初始化窗口和管理器
    // 主循环
    // 退出前释放资源
}

在这个文件中，首先定义了RSGL_IMPLEMENTATION宏，然后包含了RSGL.h头文件。这是使用RSGL的必要步骤，因为RSGL是作为单头文件库设计的。接下来，你需要创建窗口，设置渲染循环，并在退出前清理分配的资源。

3. 项目的配置文件介绍

RSGL项目的配置主要通过Makefile文件进行，该文件定义了编译RSGL库和示例程序所需的编译指令。

以下是Makefile文件的一些基本配置：

# 编译器
CC=gcc

# 编译标志
CFLAGS=-std=c99 -Wall -Wextra -pedantic -O3

# 源文件
SRC=../RSGL.h

# 目标文件
OBJ=RSGL.o

# 编译为静态库
ar rcs libRSGL.a $(OBJ)

# 编译为动态库
gcc -shared -o libRSGL.so $(OBJ)

在Makefile中，定义了编译器类型（CC）、编译标志（CFLAGS）、源文件（SRC）和目标文件（OBJ）。还包括了编译为静态库和动态库的指令。

使用make命令可以根据Makefile中的指令编译项目。如果要编译示例程序，可以进入examples/目录，并运行make命令，或者指定特定示例程序进行编译，例如make basics/basic。

以上就是RSGL项目的基本目录结构、启动文件和配置文件的介绍。使用这些信息，您可以开始搭建和运行RSGL项目，进一步探索其图形库的功能。