GNOME.org
 

[gnome-devel-docs/wip/dxhackfest2013] add getting started guides

commit 01a85abc91465aa4b036dac88f30be0ba15178e3
Author: Allan Day <allanpday gmail com>
Date:   Thu Jan 31 17:09:12 2013 +0000

    add getting started guides
    
    Add two new getting started guides for application development.

 Makefile.am                                    |    1 +
 getting-started/C/first-gnome-application.page |  110 ++++++++++++++++++++++++
 getting-started/C/libraries-introduction.page  |   63 ++++++++++++++
 getting-started/Makefile.am                    |    8 ++
 4 files changed, 182 insertions(+), 0 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index afa38fe..bf6c823 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,7 @@
 SUBDIRS =				\
 	accessibility-devel-guide	\
 	platform-demos			\
+        getting-started                 \
 	hig				\
 	integration-guide		\
 	optimization-guide		\
diff --git a/getting-started/C/first-gnome-application.page b/getting-started/C/first-gnome-application.page
new file mode 100644
index 0000000..5332517
--- /dev/null
+++ b/getting-started/C/first-gnome-application.page
@@ -0,0 +1,110 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide" style="task"
+      id="first-gnome-application.c">
+
+<info>
+  <title type="text">Writing Your First GNOME Application</title>
+  <link type="guide" xref="c"/>
+  <revision version="0.1" date="2013-01-31" status="stub"/>
+
+  <desc>An introductory guide to writing a GNOME application.</desc>
+  <credit type="author copyright">
+    <name></name>
+    <email></email>
+    <years></years>
+  </credit>
+</info>
+
+<title type="text">Writing Your First GNOME Application</title>
+
+<p>This tutorial will guide you through the basic steps involved in creating a GNOME application.</p>
+
+<section id="setting-up">
+<title>Set Up Your Development Environment</title>
+
+<p>The first stage in creating a GNOME application is to set up your development environment. For this you will need to install GNOME 3 - if you are not using GNOME 3 already, you will need to use it as the environment for developing your application. See the <link href="http://www.gnome.org/getting-gnome/";>Getting GNOME page</link> for information on GNOME 3 distributions.</p>
+
+<p>Get the tools - the following tools are recommended for writing a GNOME application:</p>
+
+<list>
+    <item><p>DevHelp - for viewing and searching API documentation.</p></item>
+    <item><p><link href="http://glade.gnome.org/";>Glade</link> - for creating your user interface.</p></item>
+    <item><p><link href="http://www.anjuta.org/downloads";>Anjunta</link> - for editing code.</p></item>
+</list>
+
+<p>All of these tools are available via GNOME 3 distributions.</p>
+</section>
+
+<section id="language">
+<title>Language</title>
+
+<p>X is the recommended language for developing GNOME applications. It is also possible to use other languages for your application, including X, Y and Z. However, if you are writing a new application for GNOME, X ... </p>
+</section>
+
+<section id="libraries">
+<title>Libraries</title>
+
+<p>We have libraries. GTK+ is essential. Additional core libraries for media, networking, etc</p>
+
+<p>See the introduction to GNOME libraries for more details.</p>
+</section>
+
+<section id="design">
+<title>Design</title>
+
+<p>Read the HIG</p>
+
+<p>Use <link href="http://glade.gnome.org/";>Glade</link>.</p>
+</section>
+
+<section id="code">
+<title>Code</title>
+
+<p>Use Anjunta and DevHelp.</p>
+
+<p>Follow the <link href="http://developer.gnome.org/gnome-devel-demos/unstable/";>tutorials</link>.</p>
+
+<p>Use version control. See the GNOME Developers <link href="https://live.gnome.org/Git/Developers";>Git guide</link>.</p>
+
+<p>Follow GNOME's style guides: <link href="ftp://ftp.mirrorservice.org/pub/GNOME/teams/docs/devel/guides/programming_guidelines/programming-guidelines.ps";>programming guidelines</link> and <link href="https://live.gnome.org/GnomeShell/Gjs_StyleGuide";>GNOME JavaScript style guide</link>.</p>
+
+<p>Look at our code - git.gnome.org.</p>
+</section>
+
+<section id="get-ready">
+<title>Get Ready to Distribute</title>
+
+<p>Get your application ready to be distributed to users.</p>
+
+<list>
+    <item><p>Ensure that your application is <link href="http://developer.gnome.org/gdp-handbook/stable/gnomedocsystem.html.en";>documented</link>.</p></item>
+    <item><p><link href="http://people.gnome.org/~malcolm/i18n/";>Internationalization</link> and <link href="http://people.gnome.org/~malcolm/i18n/";>Translation</link>.</p></item>
+    <item><p><link href="http://developer.gnome.org/accessibility-devel-guide/stable/";>Accessibility</link>.</p></item>
+</list>
+</section>
+
+<section id="test">
+<title>Test</title>
+
+<p>Testing is good.</p>
+
+<p>Is there a recommended way to debug?</p>
+
+<p>Things to test for:</p>
+
+<list>
+    <item><p>Accessibility features, including hi contrast mode and the screen reader. See <link href="https://live.gnome.org/Accessibility/Testing";>accessibility testing</link> for more details.</p></item>
+    <item><p>Left to right layout.</p></item>
+    <item><p>Different screen sizes - see the HIG for guidelines on the target screen sizes.</p></item>
+</list>
+</section>
+
+<section id="packaging">
+<title>Packaging</title>
+
+<p>File a bug with a distro or generate the packages yourself - see distro specific guidelines for this.</p>
+</section>
+
+</page>
diff --git a/getting-started/C/libraries-introduction.page b/getting-started/C/libraries-introduction.page
new file mode 100644
index 0000000..9b0291a
--- /dev/null
+++ b/getting-started/C/libraries-introduction.page
@@ -0,0 +1,63 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide" style="task"
+      id="library-intro.c">
+
+<info>
+  <title type="text">GNOME Libraries Introduction</title>
+  <link type="guide" xref="c"/>
+  <revision version="0.1" date="2013-01-31" status="stub"/>
+
+  <desc>An introductory guide to GNOME application development libraries.</desc>
+  <credit type="author copyright">
+    <name></name>
+    <email></email>
+    <years></years>
+  </credit>
+</info>
+
+<title>Introduction to GNOME Libraries</title>
+
+<p>GNOME provides a fully featured development platform. Its libraries provide frameworks for building many different types of application.</p>
+
+<section id="gtk+">
+<title>GTK+</title>
+
+<p>GTK+ is the primary library used to construct user interfaces in GNOME. It is used in almost all GNOME applications use the GTK+, GLib and GObject libraries. If you are new to GNOME application development, GTK+ is the place to start.</p>
+
+<p><link href="http://developer.gnome.org/platform-overview/stable/gtk";>Learn more about GTK+</link></p>
+</section>
+
+<section id="core-libraries">
+<title>Core Libraries</title>
+
+<p>The core libraries provide basic functionality for applications. It is likely that you will need to use one or more core library for your application.</p>
+
+<list>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/gio";>GIO</link> - GIO provides APIs for asynchronously reading and writing files and other streams.</p></item>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/webkit.html";>WebKit</link> - HTML engine which can be used to add web functionality to your application.</p></item>
+    <item><p><link href="http://developer.gnome.org/libsoup/stable/";>Soup</link> - HTTP client/server.</p></item>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/gstreamer.html.en";>GStreamer</link> - multimedia library for playing, creating, and manipulating sound, video, and other media.</p></item>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/telepathy.html";>Telepathy</link> - modular communications framework for real-time communication.</p></item>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/eds";>EDS</link> - system-wide contacts and calendar.</p></item>
+    <item><p><link href="http://projects.gnome.org/tracker/";>Tracker</link> - data storage and search engine.</p></item>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/notify.html.en";>Notify</link> - API for presenting notifications to the user.</p></item>
+</list>
+</section>
+
+<section id="utility-libraries">
+<title>Utility Libraries</title>
+
+<list>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/keyring.html";>Keyring</link> - secure storage for passwords and other data.</p></item>
+    <item><p><link href="http://developer.gnome.org/platform-overview/stable/gupnp.html";>GUPnP</link> - UPnP framework.</p></item>
+    <item><p><link href="http://developer.gnome.org/libchamplain/unstable/";>Champlain</link> - for displaying maps.</p></item>
+    <item><p><link href="http://abisource.com/projects/enchant/";>Enchant</link> - spell checking.</p></item>
+    <item><p><link href="http://developer.gnome.org/poppler/unstable/";>Poppler</link> - PDF rendering.</p></item>
+    <item><p><link href="http://avahi.org/";>Avahi</link> - service discovery on a local network via the mDNS/DNS-SD protocol suite.</p></item>
+    <item><p><link href="https://live.gnome.org/Folks";>Folks</link> - aggregrate contacts from multiple local and remote sources.</p></item>
+</list>
+</section>
+
+</page>
diff --git a/getting-started/Makefile.am b/getting-started/Makefile.am
new file mode 100644
index 0000000..3d873a8
--- /dev/null
+++ b/getting-started/Makefile.am
@@ -0,0 +1,8 @@
+ YELP_HELP_RULES@
+
+HELP_ID = gnome-devel-getting-started
+
+HELP_FILES =				\
+	c.page	                        \
+        first-gnome-application.page    \
+	libraries-introduction.page	\
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]