google / google/filament

Documentation is needed

Open
#172 18 comments 31 reactions 3 assignees Assigned to @romainguy View on GitHub
Dominant language
C++
Stars
20.5k
Forks
2.3k
Avg merge
2d 16h
Merged PRs (30d)
74

Description

We need to write on-boarding documentation in the Wiki section of the project. Most notably:

- How to setup an `Engine`, `Renderer` and `View` with SDL or equivalent
- How to setup an `Engine`, `Renderer` and `View` with Android
- How to create/load geometry (`VertexBuffer` and `IndexBuffer`)
- How to create, compile and load a simple material
- Better, simpler, stand-alone samples

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.