#91 docs:adding cookbook page with intro in TOC

myselfhimself · Apr 9, 2021 · ca779f8 · ca779f8
1 parent 29606e6
commit ca779f8
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/cookbook.rst b/docs/cookbook.rst
@@ -0,0 +1,26 @@
+Cookbook for G'MIC beginners
+============================
+
+This cookbook is intended for newcomers to the G'MIC language. It takes you by the hand step by step, starting from your Python (optionnally Numpy, Scipy..) language skills and making you learn the G'MIC image processing language the easy way a smooth methodology. ``gmic-py`` allows to you evaluate G'MIC expressions and scripts easily, but breaking the walls of the G'MIC syntax is key for newcomers to leverage the power of the G'MIC engine.
+
+The progression of this cookbook follows more or less closely five gmic.eu website's articles (`Basics <https://gmic.eu/tutorial/basics.html>`, `Images <https://gmic.eu/tutorial/images.html>`, `Selections and Command Decorations <https://gmic.eu/tutorial/command_decorations.html>`, `Images have edges - Now What? <https://gmic.eu/tutorial/images_have_edges_now_what.html>`, `Conjuring Images out of the Aether and Other Generators <https://gmic.eu/tutorial/conjuring_images_out_of_the_aether_and_other_generators.html>`). It was thought of originally in `this pixls.us community discussion <https://discuss.pixls.us/t/gmic-tutorial-fragments/24289/5>`.
+
+Basics
+###########
+TODO
+
+Images
+########
+TODO
+
+Selections and Command Decorations
+##################################
+TODO
+
+Images have Edges - Now What?
+#############################
+TODO
+
+Conjuring Images out of the Aether and Other Generators
+########################################################
+TODO
diff --git a/docs/index.rst b/docs/index.rst
@@ -25,6 +25,7 @@ Head over to the :doc:`gettingstarted` section for examples.
 
    installing
    gettingstarted
+   cookbook
    tutorials
    numpy
    PIL