summaryrefslogtreecommitdiff
path: root/README.in
diff options
context:
space:
mode:
authorRobert Bragg <robert@linux.intel.com>2012-09-03 15:32:07 +0100
committerRobert Bragg <robert@linux.intel.com>2012-09-03 15:55:14 +0100
commit1084e2fbb7e4e803e40b6dd4af0a6b5de6e57c86 (patch)
tree990d3e9513775be4d36999b83595a4bc29028ddb /README.in
parentde3e4b1560b543b52def55d8c7f79adb0906b55f (diff)
downloadcogl-1084e2fbb7e4e803e40b6dd4af0a6b5de6e57c86.tar.gz
docs: Update pointers to documentation
The generated release message and the README have been updated to point to the reference manuals hosted on developer.gnome.org and state that documentation for the experimental 2.0 api is not currently available online since we are migrating services away from clutter-project.org and may not be able to rely on it for much longer.
Diffstat (limited to 'README.in')
-rw-r--r--README.in14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.in b/README.in
index 4fbf8e35..3ccd0140 100644
--- a/README.in
+++ b/README.in
@@ -87,16 +87,18 @@ UProf is available from:
DOCUMENTATION
-------------------------------------------------------------------------------
-The API references for the latest stable release are available at:
+The 1.x stable API is documented here:
- http://docs.clutter-project.org/docs/cogl/stable/
+ http://developer.gnome.org/cogl/stable/
-The experimental 2.0 API can be found here:
+The 1.x development API is documented here:
- http://docs.clutter-project.org/docs/cogl-2.0-experimental/stable/
+ http://developer.gnome.org/cogl/1.$(COGL_1_MINOR_VERSION)
- Note: The confusing "stable" at the end refers to the overall Cogl release
- status, not the documentation specifically.
+The experimental 2.0 API is currently not hosted online but can be built
+by passing the --enable-gtk-doc option to ./configure when building
+and the documentation can then be found under
+doc/reference/cogl-2.0-experimental/html/index.html
--
LICENSE