From baea4ef62119809bc7b638aafce3eeeea8a8251a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20B=C5=93sch?= <u@pkh.me>
Date: Tue, 18 Jan 2022 14:47:19 +0100
Subject: [PATCH] doc: split documentation between users and developers

---
 README.md | 45 +++++++++++++++++++++++++++------------------
 1 file changed, 27 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 46009cf6f5..ed63ea4c02 100644
--- a/README.md
+++ b/README.md
@@ -27,40 +27,24 @@ and API can change at any time.
 [license]: /LICENSE
 [notice]: /NOTICE
 
-## 📚 Documentation
-
-### 📁 Project
-
-- [Developer guidelines][proj-developers] if you are interested in
-  contributing.
-- [Project architecture and organization][proj-archi]
+## 👤📚 Users documentation
 
 ### 🛠 Tutorial
 
-The [starter tutorial][tuto-start] is a must read before anything else if you
-are new to the project.
+- [Starter tutorial][tuto-start]
 
 ### 💡 How-to guides
 
-Following are how-to guides on various specific usages:
-
 - [Installation][howto-install]
 - [Using the C API][howto-c-api]
-- [Working with tests][howto-tests] (mainly for core developers)
-- [Writing a new node][howto-write-new-node] (for core developers only)
 
 ### ⚙️ Discussions and explanations
 
 - [node.gl standalone build environment][expl-ngl-env]
-- [How the Python binding is created][expl-pynodegl]
-- [What happens in a draw call?][expl-draw-call]
-- [Technical choices][expl-techchoices]
 - [Shaders][expl-shaders]
 - [Media (video) time remapping][expl-time-remap]
-- [The maths behind the YCbCr to RGBA color matrix][expl-colormatrix]
 - [Graphic configuration (blending, inheritance, ...)][expl-graphicconfig]
 - [How the Noise node works][expl-noise]
-- [Tests categories][expl-tests-categories]
 
 ### 🗜 Reference documentation
 
@@ -70,6 +54,31 @@ Following are how-to guides on various specific usages:
 - [ngl-tools][ref-ngl-tools]
 - [Eval][ref-eval]
 
+
+## 👷📚 Developers documentation
+
+### 🛠 Tutorial
+
+- [Writing a new node][howto-write-new-node]
+
+### 💡 How-to guides
+
+- [Working with tests][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]
+
+### 🗜 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