Skip to content

Commit 3af515d

Browse files
committed
docs
1 parent 9ea9178 commit 3af515d

3 files changed

Lines changed: 11 additions & 15 deletions

File tree

Documentation/guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
ObjectivelyGPU Guide {#guide}
2-
====================
1+
ObjectivelyGPU User Guide {#guide}
2+
=========================
33

44
A tour of drawing with ObjectivelyGPU.
55

Documentation/index.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,13 @@ Object oriented graphics framework for SDL3 and C.
1818
- **Shaders** in every format SDL3 supports (SPIR-V, MSL, DXIL), loaded by name with automatic per-backend selection
1919
- **Mathlib**: vector, matrix, and quaternion math for 3D graphics
2020

21-
## Class Hierarchy
22-
23-
Browse the [class hierarchy](hierarchy.html) to navigate the full API.
21+
## User Guide
2422

25-
## Getting Started
23+
Consult the @subpage guide [User Guide] to draw your first frame.
2624

27-
```sh
28-
autoreconf -i
29-
./configure
30-
make && sudo make install
31-
```
25+
## Class Hierarchy
3226

33-
See the @subpage guide for the render device, resource objects, framebuffers and MSAA, the typed passes, and shaders.
27+
Browse the [Class Hierarchy](hierarchy.html) to navigate the full API.
3428

3529
## Examples
3630

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Build](https://github.com/jdolan/ObjectivelyGPU/actions/workflows/build.yml/badge.svg)](https://github.com/jdolan/ObjectivelyGPU/actions/workflows/build.yml)
2-
[![Zlib License](https://img.shields.io/badge/license-Zlib-brightgreen.svg)](https://opensource.org/licenses/Zlib)
2+
[![Zlib License](https://img.shields.io/badge/license-Zlib-limegreen.svg)](https://opensource.org/licenses/Zlib)
33
![Beta](https://img.shields.io/badge/maturity-beta-yellow.svg)
44

55
# ObjectivelyGPU
@@ -47,8 +47,10 @@ if (commands) {
4747
`endFrame` resolves the multisampled `Framebuffer` and presents to the swapchain for you — no manual
4848
resolve targets, store-op bookkeeping, or present plumbing.
4949

50-
Read the **[Guide](https://jdolan.github.io/ObjectivelyGPU/guide.html)** for the render device, resource
51-
objects, framebuffers and MSAA, the typed passes, and shaders.
50+
## User Guide
51+
52+
Consult the **[User Guide](https://jdolan.github.io/ObjectivelyGPU/guide.html)** to draw your first frame — the
53+
render device, resource objects, framebuffers and MSAA, the typed passes, and shaders.
5254

5355
## API Documentation
5456

0 commit comments

Comments
 (0)