Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#91 docs: adding cookbook page with intro in TOC #92

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
26 changes: 26 additions & 0 deletions docs/cookbook.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Head over to the :doc:`gettingstarted` section for examples.

installing
gettingstarted
tutorials
cookbook
numpy
PIL
skimage
Expand Down