Skip to content

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
Added links to how to contribute and coding standards sections in docs, IRC channel, updated wiki link, etc.
  • Loading branch information
Sean Hammond committed Nov 21, 2012
1 parent 9ed808b commit c5a66fd
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions README.rst
Expand Up @@ -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 <http://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 <http://docs.ckan.org>`_ 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 <http://lists.okfn.org/mailman/listinfo/ckan-dev>`_
* Developer IRC channel: #ckan on `irc.freenode.net <http://freenode.net/>`_
* Issue tracker: `trac.ckan.org <http://trac.ckan.org/>`_


Contributing to CKAN
====================

CKAN is a free software project and code contributions are welcome.
The `For CKAN Developers <http://docs.ckan.org/en/latest/index.html#for-ckan-developers>`_
section of the documentation explains how to contribute to CKAN or its documentation,
including our **coding standards**.

The `CKAN Wiki <https://github.com/okfn/ckan/wiki>`_ is also open fo contributions.

python setup.py build_sphinx

Copying and License
===================
Expand All @@ -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

0 comments on commit c5a66fd

Please sign in to comment.