Skip to content

Commit

Permalink
doc: update paths and references to match the new README structure
Browse files Browse the repository at this point in the history
  • Loading branch information
ubitux authored and cboesch-gpsw committed Jan 20, 2022
1 parent baea4ef commit c03bb14
Show file tree
Hide file tree
Showing 50 changed files with 56 additions and 55 deletions.
93 changes: 47 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,73 +31,74 @@ and API can change at any time.

### 🛠 Tutorial

- [Starter tutorial][tuto-start]
- [Starter tutorial][usr-tuto-start]

### 💡 How-to guides

- [Installation][howto-install]
- [Using the C API][howto-c-api]
- [Installation][usr-howto-install]
- [Using the C API][usr-howto-c-api]

### ⚙️ Discussions and explanations

- [node.gl standalone build environment][expl-ngl-env]
- [Shaders][expl-shaders]
- [Media (video) time remapping][expl-time-remap]
- [Graphic configuration (blending, inheritance, ...)][expl-graphicconfig]
- [How the Noise node works][expl-noise]
- [node.gl standalone build environment][usr-expl-ngl-env]
- [Shaders][usr-expl-shaders]
- [Media (video) time remapping][usr-expl-time-remap]
- [Graphic configuration (blending, inheritance, ...)][usr-expl-graphicconfig]
- [How the Noise node works][usr-expl-noise]

### 🗜 Reference documentation

- [libnodegl][ref-libnodegl]
- [pynodegl][ref-pynodegl]
- [pynodegl-utils][ref-pynodegl-utils]
- [ngl-tools][ref-ngl-tools]
- [Eval][ref-eval]
- [libnodegl][usr-ref-libnodegl]
- [pynodegl][usr-ref-pynodegl]
- [pynodegl-utils][usr-ref-pynodegl-utils]
- [ngl-tools][usr-ref-ngl-tools]
- [Eval][usr-ref-eval]


## 👷📚 Developers documentation

### 🛠 Tutorial

- [Writing a new node][howto-write-new-node]
- [Writing a new node][dev-tuto-write-new-node]

### 💡 How-to guides

- [Working with tests][howto-tests]
- [Working with tests][dev-howto-tests]

### ⚙️ Discussions and explanations

- [How the Python binding is created][expl-pynodegl]
- [What happens in a draw call?][expl-draw-call]
- [Technical choices][expl-techchoices]
- [The maths behind the YCbCr to RGBA color matrix][expl-colormatrix]
- [Tests categories][expl-tests-categories]
- [How the Python binding is created][dev-expl-pynodegl]
- [What happens in a draw call?][dev-expl-draw-call]
- [Technical choices][dev-expl-techchoices]
- [The maths behind the YCbCr to RGBA color matrix][dev-expl-colormatrix]
- [Tests categories][dev-expl-tests-categories]

### 🗜 Reference documentation

- [Developer guidelines][proj-developers]
- [Project architecture and organization][proj-archi]


[proj-archi]: /doc/project/architecture.md
[proj-developers]: /doc/project/developers.md
[tuto-start]: /doc/tuto/start.md
[howto-install]: /doc/howto/installation.md
[howto-c-api]: /doc/howto/c-api.md
[howto-tests]: /doc/howto/tests.md
[howto-write-new-node]: /doc/howto/write-new-node.md
[expl-pynodegl]: /doc/expl/pynodegl.md
[expl-draw-call]: /doc/expl/draw-call.md
[expl-shaders]: /doc/expl/shaders.md
[expl-techchoices]: /doc/expl/techchoices.md
[expl-time-remap]: /doc/expl/media-time-remapping.md
[expl-colormatrix]: /doc/expl/colormatrix.md
[expl-graphicconfig]: /doc/expl/graphicconfig.md
[expl-ngl-env]: /doc/expl/ngl-env.md
[expl-noise]: /doc/expl/noise.md
[expl-tests-categories]: /doc/expl/tests-categories.md
[ref-libnodegl]: /libnodegl/doc/libnodegl.md
[ref-pynodegl]: /doc/ref/pynodegl.md
[ref-pynodegl-utils]: /doc/ref/pynodegl-utils.md
[ref-ngl-tools]: /doc/ref/ngl-tools.md
[ref-eval]: /doc/ref/eval.md
- [Developer guidelines][dev-ref-developers]
- [Project architecture and organization][dev-ref-archi]


[usr-tuto-start]: /doc/usr/tuto/start.md
[usr-howto-install]: /doc/usr/howto/installation.md
[usr-howto-c-api]: /doc/usr/howto/c-api.md
[usr-expl-ngl-env]: /doc/usr/expl/ngl-env.md
[usr-expl-shaders]: /doc/usr/expl/shaders.md
[usr-expl-time-remap]: /doc/usr/expl/media-time-remapping.md
[usr-expl-graphicconfig]: /doc/usr/expl/graphicconfig.md
[usr-expl-noise]: /doc/usr/expl/noise.md
[usr-ref-libnodegl]: /libnodegl/doc/libnodegl.md
[usr-ref-pynodegl]: /doc/usr/ref/pynodegl.md
[usr-ref-pynodegl-utils]: /doc/usr/ref/pynodegl-utils.md
[usr-ref-ngl-tools]: /doc/usr/ref/ngl-tools.md
[usr-ref-eval]: /doc/usr/ref/eval.md

[dev-tuto-write-new-node]: /doc/dev/tuto/write-new-node.md
[dev-howto-tests]: /doc/dev/howto/tests.md
[dev-expl-pynodegl]: /doc/dev/expl/pynodegl.md
[dev-expl-draw-call]: /doc/dev/expl/draw-call.md
[dev-expl-techchoices]: /doc/dev/expl/techchoices.md
[dev-expl-colormatrix]: /doc/dev/expl/colormatrix.md
[dev-expl-tests-categories]: /doc/dev/expl/tests-categories.md
[dev-ref-developers]: /doc/dev/ref/developers.md
[dev-ref-archi]: /doc/dev/ref/architecture.md
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions doc/howto/tests.md → doc/dev/howto/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ that's what we rely on.
Assuming node.gl has been configured through the standard procedure (using
`configure.py`), executing `make tests` is enough to trigger all the tests
(including the component specific tests). For more information on the bootstrap
procedure, see the [installation documentation](/doc/howto/installation.md).
procedure, see the [installation documentation](/doc/usr/howto/installation.md).

In case of failure, a log will be written and its path indicated on the
standard output by meson.
Expand All @@ -33,7 +33,7 @@ Many tests are based on scenes constructed in Python, sometimes available with
specific debugging options. So in order to get a visual feedback, you can
usually test them in `ngl-control`/`ngl-desktop` (or `ngl-python`), for
example: `ngl-control -m ./tests/blending.py`. For more information on the
controller usage, check out the [starter tutorial](/doc/tuto/start.md).
controller usage, check out the [starter tutorial](/doc/usr/tuto/start.md).

For cue-points or fingerprint based tests, the `TESTS_OPTIONS=dump` environment
toggle can be used to dump pictures (in `<tempdir>/nodegl/tests`).
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions doc/howto/c-api.md → doc/usr/howto/c-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ When you have access to your Python node object, you will have to get its
You probably want to look at how [ngl-python][ngl-python] performs this
operation.

[ngl-python]: /doc/ref/ngl-tools.md#ngl-python
[ngl-python]: /doc/usr/ref/ngl-tools.md#ngl-python

### Method 3: crafting the scene in C

Expand All @@ -95,7 +95,7 @@ In this section, we will assume that you are familiar with the Python binding
and how a basic `Render` node works. If not, you are encouraged to check out
the [starter tutorial][tuto-start] before reading any further.

[tuto-start]: /doc/tuto/start.md
[tuto-start]: /doc/usr/tuto/start.md

To create a node, you only need the `ngl_node_create()` function, which later
needs to be de-referenced with `ngl_node_unrefp()`.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion doc/ref/pynodegl.md → doc/usr/ref/pynodegl.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ All the others | `set_<param>(self, <param>)` | positional arguments |

[pynodegl]: /pynodegl
[libnodegl]: /libnodegl
[expl-pynodegl]: /doc/expl/pynodegl.md
[expl-pynodegl]: /doc/dev/expl/pynodegl.md
[ref-libnodegl]: /libnodegl/doc/libnodegl.md
[ref-libnodegl-group]: /libnodegl/doc/libnodegl.md#group
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
8 changes: 4 additions & 4 deletions doc/tuto/start.md → doc/usr/tuto/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Follow the ["Dependencies" and "Quick user installation" guides][install] to
bootstrap the node.gl environment. The rest of the tutorial will assume you are
in that environment.

[install]: /doc/howto/installation.md
[install]: /doc/usr/howto/installation.md

## 👁️ Running the controller

Expand Down Expand Up @@ -153,7 +153,7 @@ void main()
![my reddish demo](img/ngl-control-reddish-scene.png)

[book-of-shaders]: http://thebookofshaders.com/
[expl-shaders]: /doc/expl/shaders.md
[expl-shaders]: /doc/usr/expl/shaders.md

### Introducing uniforms

Expand Down Expand Up @@ -201,7 +201,7 @@ def test_demo(cfg, color=(1,0,0,1)):
All the other widgets are documented in the [Controller widgets
documentation][controller-widgets].

[controller-widgets]: /doc/ref/pynodegl-utils.md#controller-widgets
[controller-widgets]: /doc/usr/ref/pynodegl-utils.md#controller-widgets

### Animations

Expand Down Expand Up @@ -454,4 +454,4 @@ when starting a creative process.
[expl]: /README.md#%EF%B8%8F-discussions-and-explanations
[refdoc]: /README.md#-reference-documentation
[ref-libnodegl]: /libnodegl/doc/libnodegl.md
[ref-pynodegl-utils]: /doc/ref/pynodegl-utils.md
[ref-pynodegl-utils]: /doc/usr/ref/pynodegl-utils.md

0 comments on commit c03bb14

Please sign in to comment.