← Back to branch summary

~kissiel/checkbox/error-reporting

« back to all changes in this revision

Viewing changes to checkbox-ng/docs/index.rst

  • Committer: Zygmunt Krynicki
  • Date: 2013-05-17 13:54:25 UTC
  • mto: This revision was merged to the branch mainline in revision 2130.
  • Revision ID: zygmunt.krynicki@canonical.com-20130517135425-cxcenxx5t0qrtbxd
checkbox-ng: add CheckBoxNG sub-project

CheckBoxNG (or lowercase as checkbox-ng, pypi:checkbox-ng) is a clean
implementation of CheckBox on top of PlainBox. It provides a new
executable, 'checkbox' that has some of the same commands that were
previously implemented in the plainbox package.

In particular CheckBoxNG comes with the 'checkbox sru' command
(the same one as in plainbox). Later on this sub-command will be removed
from plainbox.

CheckBoxNG depends on plainbox >= 0.3

Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@canonical.com>

Show diffs side-by-side

added added

removed removed

Lines of Context:
checkbox-ng/docs/index.rst
 
1
.. CheckBoxNG documentation master file, created by
 
2
   sphinx-quickstart on Wed Feb 13 11:18:39 2013.
 
3
   You can adapt this file completely to your liking, but it should at least
 
4
   contain the root `toctree` directive.
 
5
 
 
6
CheckBoxNG
 
7
==========
 
8
 
 
9
:term:`CheckBoxNG` is a hardware testing tool useful for certifying laptops,
 
10
desktops and servers with Ubuntu. It is a new version of :term:`CheckBox` that
 
11
is built directly on top of :term:`PlainBox`
 
12
 
 
13
CheckBoxNG *replaces* CheckBox, where applicable. 
 
14
 
 
15
.. warning::
 
16
 
 
17
    Documentation is under development. Some things are wrong, inaccurate or
 
18
    describe development goals rather than current state.
 
19
 
 
20
Installation
 
21
^^^^^^^^^^^^
 
22
 
 
23
CheckBoxNG can be installed from a :abbr:`PPA (Personal Package Archive)`
 
24
(recommended) or :abbr:`pypi (python package index)` on Ubuntu Precise (12.04)
 
25
or newer.
 
26
 
 
27
.. code-block:: bash
 
28
 
 
29
    $ sudo add-apt-repository ppa:checkbox-dev/ppa && sudo apt-get update && sudo apt-get install checkbox-ng 
 
30
 
 
31
Table of contents
 
32
=================
 
33
 
 
34
.. toctree::
 
35
   :maxdepth: 2
 
36
 
 
37
Indices and tables
 
38
==================
 
39
 
 
40
* :ref:`genindex`
 
41
* :ref:`modindex`
 
42
* :ref:`search`