Skip to content

Commit

Permalink
Merge pull request #36 from evanmartiin/develop
Browse files Browse the repository at this point in the history
[Docs] Add documentation
  • Loading branch information
plepers authored Dec 4, 2023
2 parents 5ca31a2 + b2665f4 commit 55b52f3
Show file tree
Hide file tree
Showing 27 changed files with 18,966 additions and 3,481 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Trigger docs re-build

on:
push:
branches:
- 'develop'

jobs:
trigger_docs:
name: Trigger docs re-build
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v6
with:
github-token: ${{ secrets.ACTIONS_KEY }}
script: |
await github.rest.actions.createWorkflowDispatch({
owner: 'evanmartiin',
repo: 'nanogl-docs',
workflow_id: 'main.yml',
ref: 'main'
})
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
[![Build Status](https://travis-ci.org/plepers/nanogl.svg?branch=master)](https://travis-ci.org/plepers/nanogl)


# nanogl
webgl micro framework (3Ko)
[![NPM Package](https://img.shields.io/npm/v/nanogl.svg)](https://www.npmjs.com/package/nanogl) [![NPM Downloads](https://img.shields.io/npm/dw/nanogl)](https://npmtrends.com/nanogl) [![GitHub](https://img.shields.io/github/license/plepers/nanogl)](https://github.com/plepers/nanogl/blob/develop/LICENSE)

#### Quick guides
nanogl is a WebGL micro framework (3Ko)

- [Texture](docs/texture.md)
- [Program](docs/program.md)
- [FBO](docs/fbo.md)
- [ArrayBuffer](docs/arraybuffer.md)
- [IndexBuffer](docs/indexbuffer.md)
[Guide](https://makemepulse.github.io/nanogl-docs/guide) | [API](https://makemepulse.github.io/nanogl-docs/api) | [Examples](https://makemepulse.github.io/nanogl-docs/examples)

#### Libraries

#### API
http://plepers.github.io/nanogl/
There are libraries to expand nanogl for useful features :
- [nanogl-camera](https://github.com/plepers/nanogl-camera) : Cameras for nanogl
- [nanogl-node](https://github.com/plepers/nanogl-node) : Handle nested objects transform in 3D space
- [nanogl-primitives-2d](https://github.com/plepers/nanogl-primitives-2d) : Basic 2D primitives for nanogl
- [nanogl-glft](https://github.com/plepers/nanogl-gltf) : Handle .gltf files
- [nanogl-pbr](https://github.com/plepers/nanogl-pbr) : Physically based rendering materials for nanogl
- [nanogl-pf](https://github.com/plepers/nanogl-pf) : Provide pixel format related capabilities
- [nanogl-post](https://github.com/plepers/nanogl-post) : Post-processing for nanogl
- [nanogl-state](https://github.com/plepers/nanogl-state) : Efficient webgl state management
- [nanogl-sync](https://github.com/plepers/nanogl-sync) : WebGLSync for nanogl
- [nanogl-vao](https://github.com/plepers/nanogl-vao) : OES_vertex_array_object extension support for nanogl

#### Build and test

Expand Down
67 changes: 0 additions & 67 deletions docs/arraybuffer.md

This file was deleted.

Loading

0 comments on commit 55b52f3

Please sign in to comment.