From c5a66fd60eb5971464e375c6a7fa5c83439e9d56 Mon Sep 17 00:00:00 2001 From: Sean Hammond Date: Wed, 21 Nov 2012 22:02:14 +0100 Subject: [PATCH] Update the README Added links to how to contribute and coding standards sections in docs, IRC channel, updated wiki link, etc. --- README.rst | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 2235d807868..d960fb13f2a 100644 --- a/README.rst +++ b/README.rst @@ -2,26 +2,33 @@ CKAN is open-source data hub software. CKAN makes it easy to publish, share and work with data. It's a data management system that provides a powerful platform for cataloging, storing and accessing datasets with a rich front-end, full API (for both data and catalog), visualization tools and more. Read more at -http://ckan.org/. +`ckan.org `_. - * Installation instructions: see docs at http://docs.ckan.org/ - * Project wiki: http://wiki.ckan.org/ - * Developer mailing list: ckan-dev@lists.okfn.org - * Issue tracker: http://trac.ckan.org/ -Building Documentation -====================== +Installation +============ -1. Install python-sphinx (>= 1.1) +See the `CKAN Documentation `_ for installation instructions. -2. Initialize the theme submodule:: - git submodule init - git submodule update +Community +========= -3. Run the command to build the docs:: +* Developer mailing list: `ckan-dev@lists.okfn.org `_ +* Developer IRC channel: #ckan on `irc.freenode.net `_ +* Issue tracker: `trac.ckan.org `_ + + +Contributing to CKAN +==================== + +CKAN is a free software project and code contributions are welcome. +The `For CKAN Developers `_ +section of the documentation explains how to contribute to CKAN or its documentation, +including our **coding standards**. + +The `CKAN Wiki `_ is also open fo contributions. - python setup.py build_sphinx Copying and License =================== @@ -31,5 +38,4 @@ This material is copyright (c) 2006-2011 Open Knowledge Foundation. It is open and licensed under the GNU Affero General Public License (AGPL) v3.0 whose full text may be found at: -http://www.fsf.org/licensing/licenses/agpl-3.0.html - +http://www.fsf.org/licensing/licenses/agpl-3.0.html \ No newline at end of file