diff --git a/README.md b/README.md index ed63ea4c02..b3b50308c1 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/expl/Makefile b/doc/dev/expl/Makefile similarity index 100% rename from doc/expl/Makefile rename to doc/dev/expl/Makefile diff --git a/doc/expl/binding.dot b/doc/dev/expl/binding.dot similarity index 100% rename from doc/expl/binding.dot rename to doc/dev/expl/binding.dot diff --git a/doc/expl/binding.png b/doc/dev/expl/binding.png similarity index 100% rename from doc/expl/binding.png rename to doc/dev/expl/binding.png diff --git a/doc/expl/colormatrix.md b/doc/dev/expl/colormatrix.md similarity index 100% rename from doc/expl/colormatrix.md rename to doc/dev/expl/colormatrix.md diff --git a/doc/expl/draw-call.md b/doc/dev/expl/draw-call.md similarity index 100% rename from doc/expl/draw-call.md rename to doc/dev/expl/draw-call.md diff --git a/doc/expl/pynodegl.md b/doc/dev/expl/pynodegl.md similarity index 100% rename from doc/expl/pynodegl.md rename to doc/dev/expl/pynodegl.md diff --git a/doc/expl/techchoices.md b/doc/dev/expl/techchoices.md similarity index 100% rename from doc/expl/techchoices.md rename to doc/dev/expl/techchoices.md diff --git a/doc/expl/tests-categories.md b/doc/dev/expl/tests-categories.md similarity index 100% rename from doc/expl/tests-categories.md rename to doc/dev/expl/tests-categories.md diff --git a/doc/howto/tests.md b/doc/dev/howto/tests.md similarity index 97% rename from doc/howto/tests.md rename to doc/dev/howto/tests.md index 6d00d7a9ec..4646f04993 100644 --- a/doc/howto/tests.md +++ b/doc/dev/howto/tests.md @@ -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. @@ -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 `/nodegl/tests`). diff --git a/doc/project/Makefile b/doc/dev/ref/Makefile similarity index 100% rename from doc/project/Makefile rename to doc/dev/ref/Makefile diff --git a/doc/project/architecture.md b/doc/dev/ref/architecture.md similarity index 100% rename from doc/project/architecture.md rename to doc/dev/ref/architecture.md diff --git a/doc/project/dependencies.dot b/doc/dev/ref/dependencies.dot similarity index 100% rename from doc/project/dependencies.dot rename to doc/dev/ref/dependencies.dot diff --git a/doc/project/dependencies.png b/doc/dev/ref/dependencies.png similarity index 100% rename from doc/project/dependencies.png rename to doc/dev/ref/dependencies.png diff --git a/doc/project/developers.md b/doc/dev/ref/developers.md similarity index 100% rename from doc/project/developers.md rename to doc/dev/ref/developers.md diff --git a/doc/howto/write-new-node.md b/doc/dev/tuto/write-new-node.md similarity index 100% rename from doc/howto/write-new-node.md rename to doc/dev/tuto/write-new-node.md diff --git a/doc/expl/graphicconfig.md b/doc/usr/expl/graphicconfig.md similarity index 100% rename from doc/expl/graphicconfig.md rename to doc/usr/expl/graphicconfig.md diff --git a/doc/expl/img/noise/fbm.png b/doc/usr/expl/img/noise/fbm.png similarity index 100% rename from doc/expl/img/noise/fbm.png rename to doc/usr/expl/img/noise/fbm.png diff --git a/doc/expl/img/noise/gradient-interp.png b/doc/usr/expl/img/noise/gradient-interp.png similarity index 100% rename from doc/expl/img/noise/gradient-interp.png rename to doc/usr/expl/img/noise/gradient-interp.png diff --git a/doc/expl/img/noise/gradient-noise.png b/doc/usr/expl/img/noise/gradient-noise.png similarity index 100% rename from doc/expl/img/noise/gradient-noise.png rename to doc/usr/expl/img/noise/gradient-noise.png diff --git a/doc/expl/img/noise/graph.png b/doc/usr/expl/img/noise/graph.png similarity index 100% rename from doc/expl/img/noise/graph.png rename to doc/usr/expl/img/noise/graph.png diff --git a/doc/expl/img/noise/value-noise.png b/doc/usr/expl/img/noise/value-noise.png similarity index 100% rename from doc/expl/img/noise/value-noise.png rename to doc/usr/expl/img/noise/value-noise.png diff --git a/doc/expl/media-time-remapping.md b/doc/usr/expl/media-time-remapping.md similarity index 100% rename from doc/expl/media-time-remapping.md rename to doc/usr/expl/media-time-remapping.md diff --git a/doc/expl/media-time-remapping.png b/doc/usr/expl/media-time-remapping.png similarity index 100% rename from doc/expl/media-time-remapping.png rename to doc/usr/expl/media-time-remapping.png diff --git a/doc/expl/ngl-env.md b/doc/usr/expl/ngl-env.md similarity index 100% rename from doc/expl/ngl-env.md rename to doc/usr/expl/ngl-env.md diff --git a/doc/expl/noise.md b/doc/usr/expl/noise.md similarity index 100% rename from doc/expl/noise.md rename to doc/usr/expl/noise.md diff --git a/doc/expl/shaders.md b/doc/usr/expl/shaders.md similarity index 100% rename from doc/expl/shaders.md rename to doc/usr/expl/shaders.md diff --git a/doc/howto/c-api.md b/doc/usr/howto/c-api.md similarity index 98% rename from doc/howto/c-api.md rename to doc/usr/howto/c-api.md index 4cc64b22be..7238979c8f 100644 --- a/doc/howto/c-api.md +++ b/doc/usr/howto/c-api.md @@ -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 @@ -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()`. diff --git a/doc/howto/installation.md b/doc/usr/howto/installation.md similarity index 100% rename from doc/howto/installation.md rename to doc/usr/howto/installation.md diff --git a/doc/ref/eval.md b/doc/usr/ref/eval.md similarity index 100% rename from doc/ref/eval.md rename to doc/usr/ref/eval.md diff --git a/doc/ref/img/ngl-player.png b/doc/usr/ref/img/ngl-player.png similarity index 100% rename from doc/ref/img/ngl-player.png rename to doc/usr/ref/img/ngl-player.png diff --git a/doc/ref/img/widget-bool.png b/doc/usr/ref/img/widget-bool.png similarity index 100% rename from doc/ref/img/widget-bool.png rename to doc/usr/ref/img/widget-bool.png diff --git a/doc/ref/img/widget-color.png b/doc/usr/ref/img/widget-color.png similarity index 100% rename from doc/ref/img/widget-color.png rename to doc/usr/ref/img/widget-color.png diff --git a/doc/ref/img/widget-file.png b/doc/usr/ref/img/widget-file.png similarity index 100% rename from doc/ref/img/widget-file.png rename to doc/usr/ref/img/widget-file.png diff --git a/doc/ref/img/widget-list.png b/doc/usr/ref/img/widget-list.png similarity index 100% rename from doc/ref/img/widget-list.png rename to doc/usr/ref/img/widget-list.png diff --git a/doc/ref/img/widget-range.png b/doc/usr/ref/img/widget-range.png similarity index 100% rename from doc/ref/img/widget-range.png rename to doc/usr/ref/img/widget-range.png diff --git a/doc/ref/img/widget-text.png b/doc/usr/ref/img/widget-text.png similarity index 100% rename from doc/ref/img/widget-text.png rename to doc/usr/ref/img/widget-text.png diff --git a/doc/ref/img/widget-vector.png b/doc/usr/ref/img/widget-vector.png similarity index 100% rename from doc/ref/img/widget-vector.png rename to doc/usr/ref/img/widget-vector.png diff --git a/doc/ref/ngl-tools.md b/doc/usr/ref/ngl-tools.md similarity index 100% rename from doc/ref/ngl-tools.md rename to doc/usr/ref/ngl-tools.md diff --git a/doc/ref/pynodegl-utils.md b/doc/usr/ref/pynodegl-utils.md similarity index 100% rename from doc/ref/pynodegl-utils.md rename to doc/usr/ref/pynodegl-utils.md diff --git a/doc/ref/pynodegl.md b/doc/usr/ref/pynodegl.md similarity index 98% rename from doc/ref/pynodegl.md rename to doc/usr/ref/pynodegl.md index 1441e73f1a..9bcc0a76e6 100644 --- a/doc/ref/pynodegl.md +++ b/doc/usr/ref/pynodegl.md @@ -35,6 +35,6 @@ All the others | `set_(self, )` | 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 diff --git a/doc/tuto/img/graph-simple-render.png b/doc/usr/tuto/img/graph-simple-render.png similarity index 100% rename from doc/tuto/img/graph-simple-render.png rename to doc/usr/tuto/img/graph-simple-render.png diff --git a/doc/tuto/img/graph-translate.png b/doc/usr/tuto/img/graph-translate.png similarity index 100% rename from doc/tuto/img/graph-translate.png rename to doc/usr/tuto/img/graph-translate.png diff --git a/doc/tuto/img/graph-uniform-color-demo.png b/doc/usr/tuto/img/graph-uniform-color-demo.png similarity index 100% rename from doc/tuto/img/graph-uniform-color-demo.png rename to doc/usr/tuto/img/graph-uniform-color-demo.png diff --git a/doc/tuto/img/ngl-control-3-basic-shapes.png b/doc/usr/tuto/img/ngl-control-3-basic-shapes.png similarity index 100% rename from doc/tuto/img/ngl-control-3-basic-shapes.png rename to doc/usr/tuto/img/ngl-control-3-basic-shapes.png diff --git a/doc/tuto/img/ngl-control-color-widget.png b/doc/usr/tuto/img/ngl-control-color-widget.png similarity index 100% rename from doc/tuto/img/ngl-control-color-widget.png rename to doc/usr/tuto/img/ngl-control-color-widget.png diff --git a/doc/tuto/img/ngl-control-reddish-scene.png b/doc/usr/tuto/img/ngl-control-reddish-scene.png similarity index 100% rename from doc/tuto/img/ngl-control-reddish-scene.png rename to doc/usr/tuto/img/ngl-control-reddish-scene.png diff --git a/doc/tuto/img/ngl-control.png b/doc/usr/tuto/img/ngl-control.png similarity index 100% rename from doc/tuto/img/ngl-control.png rename to doc/usr/tuto/img/ngl-control.png diff --git a/doc/tuto/img/timeranges.gif b/doc/usr/tuto/img/timeranges.gif similarity index 100% rename from doc/tuto/img/timeranges.gif rename to doc/usr/tuto/img/timeranges.gif diff --git a/doc/tuto/start.md b/doc/usr/tuto/start.md similarity index 98% rename from doc/tuto/start.md rename to doc/usr/tuto/start.md index ef93042875..66c05c7b36 100644 --- a/doc/tuto/start.md +++ b/doc/usr/tuto/start.md @@ -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 @@ -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 @@ -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 @@ -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