Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Zygmunt Krynicki committed Jun 23, 2011
1 parent ee62fa1 commit 2dcd9a7
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 65 deletions.
1 change: 0 additions & 1 deletion HACKING

This file was deleted.

1 change: 0 additions & 1 deletion INSTALL

This file was deleted.

1 change: 0 additions & 1 deletion NEWS

This file was deleted.

12 changes: 3 additions & 9 deletions README
@@ -1,16 +1,10 @@
About
=====

This source package contains useful JSON utilities developed by the Linaro
(www.linaro.org) Infrastructure Team.
This package contains an implementation of JSON Schema validator as defined by
http://json-schema.org/

Installation
============

See INSTALL

Reporting Bugs
==============

All bugs should be reported to the launchpad project at
https://bugs.launchpad.net/linaro-python-json/+filebug
pip install json-schema-validator
7 changes: 6 additions & 1 deletion doc/changes.rst
@@ -1,6 +1,11 @@
Version History
***************

Version 2.1
===========

* Renamed from linaro-json to json-schema-validator and moved to github.

Version 2.0.1
=============

Expand Down Expand Up @@ -37,7 +42,7 @@ Version 1.2.1
Version 1.2
===========

* Change name to linaro-json
* Change name to json-schema-validator
* Add dependency on versiontools
* Register on pypi
* Add ReST documentation
Expand Down
24 changes: 13 additions & 11 deletions doc/hacking.rst
Expand Up @@ -2,18 +2,15 @@
Hacking
*******

Dear hackers.

The project is hosted on http://launchpad.net/linaro-python-json/ *and*
http://pypi.python.org/linaro-json/. There is a name difference, the canonical
name is ``linaro-json``. I cannot rename the project on launchpad so we'll have
to live with both.
The project is hosted on github
(http://github.com/zyga/json-schema-validator/), feel free to fork it and
propose a pull request.

Goals
-----

The goal of this project is to construct an universal collection of tools to
work with JSON documents in python.
The goal of this project is to construct a complete and fast implementation of the
JSON Schema as defined by http://json-schema.org/.

JSON is powerful because of the simplicity. Unlike the baroque YAML it thrives
on being easy to implement in any language, correctly, completely, with
Expand All @@ -26,11 +23,16 @@ and integrity checking.
Infrastructure
--------------

Launchpad.net is used for:
Github is used for:

* Hosting source code (in bzr)
* Hosting source code (in git)
* Reporting and tracking bugs
* Project management (release tracking, feature tracking, etc)


Launchpad.net is used for:

* Hosting source code (as bzr mirror)
* Packaging aid for Ubuntu

PyPi is used for:

Expand Down
42 changes: 1 addition & 41 deletions doc/installation.rst
Expand Up @@ -23,51 +23,11 @@ Installation Options

There are several installation options available:

Using Ubuntu PPAs
-----------------

For Ubuntu 10.04 onward there is a PPA (personal package archive):

* ppa:zkrynicki/lava

This PPA has only stable releases. To add it to an Ubuntu system use the
add-apt-repository command::

sudo add-apt-repository ppa:zkrynicki/lava

After you add the PPA you need to update your package cache::

sudo apt-get update

Finally you can install the package, it is called `python-linaro-json`::

sudo apt-get install python-linaro-json


Using Python Package Index
--------------------------

This package is being actively maintained and published in the `Python Package
Index <http://http://pypi.python.org>`_. You can install it if you have `pip
<http://pip.openplans.org/>`_ tool using just one line::

pip install linaro-json


Using source tarball
--------------------

To install from source you must first obtain a source tarball from either
`pypi project page <http://pypi.python.org/pypi/linaro-json>`_
or from `Launchpad project page <http://launchpad.net/linaro-python-json>`_.
To install the package unpack the tarball and run::

python setup.py install

You can pass ``--user`` if you prefer to do a local (non system-wide) installation.

.. note::

To install from source you will need distutils (replacement of setuptools)
They are typically installed on any Linux system with python but on Windows
you may need to install that separately.
pip install json-schema-validator

0 comments on commit 2dcd9a7

Please sign in to comment.