Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexchicn committed Oct 15, 2020
1 parent 152522f commit 2d65841
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 12 deletions.
8 changes: 6 additions & 2 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@ name: 'coverage'
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
paths-ignore:
- 'docs/**'
- '*.md'
- 'LICENSE'
- '.readthedocs.yml'
- '.git*'

jobs:
coveralls:
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@
[![glTF status](https://img.shields.io/badge/glTF-2%2E0-green.svg?style=flat)](https://github.com/KhronosGroup/glTF)
[![libgltf document](https://readthedocs.org/projects/libgltf/badge/?version=latest)](http://libgltf.rtfd.io/)
[![visit milestones](https://img.shields.io/badge/visit-milestones-blue.svg?style=flat)](https://github.com/code4game/libgltf/milestones)
[![CII best practices](https://bestpractices.coreinfrastructure.org/projects/1434/badge)](https://bestpractices.coreinfrastructure.org/projects/1434)

[![build](https://github.com/code4game/libgltf/workflows/build/badge.svg)](https://github.com/code4game/libgltf/actions?query=workflow%3Abuild)
[![build with draco](https://github.com/code4game/libgltf/workflows/build%20with%20draco/badge.svg)](https://github.com/code4game/libgltf/actions?query=workflow%3A%22build+with+draco%22)

[![Coverage status from coveralls](https://coveralls.io/repos/github/code4game/libgltf/badge.svg?branch=master)](https://coveralls.io/github/code4game/libgltf?branch=master)
[![Codacy](https://api.codacy.com/project/badge/Grade/fa7ee9a5bc9b4befb703298ca721bc9a)](https://www.codacy.com/app/code4game/libgltf?utm_source=github.com&utm_medium=referral&utm_content=code4game/libgltf&utm_campaign=Badge_Grade)
[![CII best practices](https://bestpractices.coreinfrastructure.org/projects/1434/badge)](https://bestpractices.coreinfrastructure.org/projects/1434)

[![Support](https://img.shields.io/badge/support-buy%20a%20cup%20of%20coffee-orange.svg?style=flat)](https://c4gio.itch.io/libgltf-ue4)
[![Become a patreon](https://img.shields.io/badge/donation-become%20a%20patreon-orange.svg?style=flat)](https://www.patreon.com/bePatron?u=7553208)
Expand Down
22 changes: 15 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
Welcome to libgltf's documentation!
===================================

|glTF 2.0| |docs| |visit-milstones|
|glTF 2.0| |docs| |bestpractices| |visit-milstones|

|azure-ci| |coveralls| |codacy| |bestpractices|
|github-action| |coveralls| |codacy|

This project was generated by glTF 2.0 JSON schema and support to load the glTF 2.0 file to a struct `SGlTF`.

Expand Down Expand Up @@ -152,6 +152,10 @@ Check the `LIBGLTF_USE_GOOGLE_DRACO` or set `LIBGLTF_USE_GOOGLE_DRACO` is `TRUE`
* Set the `GOOGLE_DRACO_PATH_INCLUDE`, `GOOGLE_DRACO_PATH_BUILD`, `GOOGLE_DRACO_LIBRARY_DRACODEC_DEBUG`, `GOOGLE_DRACO_LIBRARY_DRACODEC_RELEASE`, `GOOGLE_DRACO_LIBRARY_DRACOENC_DEBUG` and `GOOGLE_DRACO_LIBRARY_DRACOENC_RELEASE`.
* Or enable the `LIBGLTF_USE_GOOGLE_DRACO_SUBMODULE` to compile with the submodule - `external/draco`.

Download the compiled library
-----------------------------

This project is compiled by github action, and you can download the compiled library with `Google's Draco`_ from `the action page`_ or `the release page`_.

Donation
==============================================================
Expand Down Expand Up @@ -179,27 +183,31 @@ The MIT license.

.. _VisualStudio: https://visualstudio.microsoft.com

.. _`the action page`: https://github.com/code4game/libgltf/actions

.. _`the release page`: https://github.com/code4game/libgltf/releases

.. |glTF 2.0| image:: https://img.shields.io/badge/glTF-2%2E0-green.svg?style=flat
:target: https://github.com/KhronosGroup/glTF

.. |docs| image:: https://readthedocs.org/projects/libgltf/badge/?version=latest
:target: http://libgltf.rtfd.io/

.. |bestpractices| image:: https://bestpractices.coreinfrastructure.org/projects/1434/badge
:target: https://bestpractices.coreinfrastructure.org/projects/1434

.. |visit-milstones| image:: https://img.shields.io/badge/visit-milestones-blue.svg?style=flat
:target: https://github.com/code4game/libgltf/milestones

.. |azure-ci| image:: https://dev.azure.com/code4game/libgltf/_apis/build/status/code4game.libgltf
:target: https://dev.azure.com/code4game/libgltf/_build/latest?definitionId=1
.. |github-action| image:: https://github.com/code4game/libgltf/workflows/build/badge.svg
:target: https://github.com/code4game/libgltf/actions?query=workflow%3Abuild

.. |coveralls| image:: https://coveralls.io/repos/github/code4game/libgltf/badge.svg?branch=master
:target: https://coveralls.io/github/code4game/libgltf?branch=master

.. |codacy| image:: https://api.codacy.com/project/badge/Grade/fa7ee9a5bc9b4befb703298ca721bc9a
:target: https://www.codacy.com/app/code4game/libgltf?utm_source=github.com&utm_medium=referral&utm_content=code4game/libgltf&utm_campaign=Badge_Grade

.. |bestpractices| image:: https://bestpractices.coreinfrastructure.org/projects/1434/badge
:target: https://bestpractices.coreinfrastructure.org/projects/1434

.. |support-buy-a-cup-of-coffee| image:: https://img.shields.io/badge/support-buy%20a%20cup%20of%20coffee-orange.svg?style=flat
:target: https://c4gio.itch.io/libgltf-ue4

Expand Down

0 comments on commit 2d65841

Please sign in to comment.