Skip to content

Commit 362143e

Browse files
committed
Merge pull request #108 from enthought/bugfix/update-readme
Update README.
2 parents 7de7a4d + 9383b5d commit 362143e

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,22 @@
44
Distributed Array Protocol
55
==========================
66

7-
Source repository for the Distributed Array Protocol document.
7+
Source repository for the Distributed Array Protocol document and associated
8+
utilities.
89

9-
The document itself is `protocol.rst`, located in this directory.
10+
A validator for data structures defined in the protocol is included as
11+
``validator.py``.
1012

11-
For a version of this document rendered as HTML, see
13+
For a version of the protocol document rendered as HTML, see
1214

1315
http://distributed-array-protocol.readthedocs.org
16+
17+
To build a version of the protocol document yourself, install `Sphinx`_, then
18+
run ``make html`` or ``make singlehtml`` in this directory. See the output of
19+
``make help`` for more information.
20+
21+
.. _Sphinx: http://sphinx-doc.org/
22+
23+
To run the tests for the validator and included utilities, run ``python -m
24+
unittest discover`` from this directory.
25+

0 commit comments

Comments
 (0)