From 2557370445ccc841adddb369fe004ed2e91043e9 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 1 Sep 2011 16:06:04 +0100 Subject: [PATCH] docs/cookbook: Update the introduction Clean up some wording. --- doc/cookbook/introduction.xml | 62 ++++++++++++++++++++++++++++++----- 1 file changed, 53 insertions(+), 9 deletions(-) diff --git a/doc/cookbook/introduction.xml b/doc/cookbook/introduction.xml index f88fd6d4c..ee9ac1b1c 100644 --- a/doc/cookbook/introduction.xml +++ b/doc/cookbook/introduction.xml @@ -15,7 +15,7 @@ There is a wonderful simile in the preface of the Perl Cookbook: approaching a programming problem is oftentimes similar to balancing Columbus's egg. The initial difficulties of dealing - with, and more importantly solving, problems in the computer programming + with, and more importantly solving, problems in the software engineering field sometimes can only be overcome if somebody shows you how to use a new tool. This is true for programming languages but also for programming libraries. @@ -24,14 +24,14 @@ how to solve common issues that you might have to face when using the Clutter toolkit. - This book is not meant to be a replacement for the API reference, - even though there will be descriptions of how Clutter works and how - its API looks like. We will require knowledge of the Clutter API, but - we will also point out where to find more information on the API that + This book is not meant to be a replacement for the Clutter API + reference, even though there will be descriptions of how Clutter works + and how its API looks like. We will require knowledge of the Clutter API, + but we will also point out where to find more information on the API that examples have used. Indeed, this book should be used as a companion to the API reference, - expanding the examples and showing how to achieve a specific result. + expanding its examples and showing how to achieve a specific result. This is not a book for learning Clutter. This is also not a book for learning C, or GObject or even GUI development. @@ -46,8 +46,8 @@ recipes. Each recipe starts with a problem, or a short statement describing what we want to achieve; a solution, containing the source code; and a discussion section, where the code is explained, where - alternative approaches might be useful, caveats and references to the - Clutter API for furher studying. + alternative approaches might be useful, and where caveats and references to + the Clutter API for further studying can be found. This book, in the cookbook spirit, can be accessed mostly at random. @@ -77,6 +77,32 @@ The latest version is always available at &docurl;. + To contribute to this document, see the + Contributing appendix. + +
+ Compiling the examples + + This document comes with full examples, usually stored + on disk in datadir/clutter-1.0/cookbook/examples + directory. + + Each example can be compiled using: + + + +cc \ + `pkg-config --cflags clutter-1.0` \ + -o example example.c \ + `pkg-config --libs clutter-1.0` + + + + substituting the example with in the + line above with the name of the example. + +
+
@@ -85,12 +111,30 @@ This book has been written taking the inspiration from the Perl Cookbook, authored by Tom Christiansen and Nathan Torkington. + This book would not have been possible without the existence of + the Clutter library itself, and without the help and contributions of + all the people that have been working on it every day. + +
+ Acknowledgments from Emmanuele + + To Matthew, for starting the flame. To Robert and Neil, for + keeping it ablaze. + + To Marta, for her love and patience. +
+ +
+ Acknowledgements from Elliot +
+
Where to get Clutter - You can obtain Clutter from &appurl;. + You can obtain the Clutter source code ready for compilation + from &appurl;. Clutter is also available on all major GNU/Linux distributions, in various package formats.