git.cweiske.de
/
ouya-store-api.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
use rst2html5 to render docs
[ouya-store-api.git]
/
README.rst
diff --git
a/README.rst
b/README.rst
index 0954cf11240b14b2b7661e9ae090de2b91b74c7b..e910d599a474d66c81e72e773a071ccbe9ec92d7 100644
(file)
--- a/
README.rst
+++ b/
README.rst
@@
-2,7
+2,7
@@
OUYA store API documentation
****************************
OUYA store API documentation
****************************
-This is an attempt to document the API used by OUYA gaming
devic
es to
+This is an attempt to document the API used by OUYA gaming
consol
es to
speak with ``devs.ouya.tv``.
.. contents::
speak with ``devs.ouya.tv``.
.. contents::
@@
-66,3
+66,16
@@
Home page
=========
A rendered version of this documentation is available at
http://cweiske.de/ouya-store-api-docs.htm
=========
A rendered version of this documentation is available at
http://cweiske.de/ouya-store-api-docs.htm
+
+
+
+Building
+========
+You need to install ``rst2html5`` before::
+
+ $ pip install rst2html5-tools
+
+Rendering the docs is done via a build script::
+
+ $ ./build.sh
+