aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorPhilipp A2020-01-03 16:43:21 +0100
committerPhilipp A2020-01-03 16:48:39 +0100
commit06e7d81088e33d7ee03e7088e1ec2289e9c2bf5c (patch)
tree59daa73de46abfdc60a6e3e4c11b43011ff49053 /README.rst
parent0f1a3e3578b934454a41a31eff15c23622719a67 (diff)
downloadrust-rst-0.3.1-renderer.tar.bz2
Added code block directivev0.3.1-rendererv0.3.1-parser
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 9d8e3cb..d8a9f5d 100644
--- a/README.rst
+++ b/README.rst
@@ -10,7 +10,14 @@ RuSTructuredText |travis|
Designed around the `Docutils Document Tree`_ and the `reStructuredText specification`_,
this is supposed to become a library able to convert reStructuredText and Docutils XML to both each other and HTML5.
-Currently it can convert a subset of rST (e.g. this README) to HTML5.
+Currently it can convert a subset of rST (e.g. this README) to HTML5:
+
+.. code-block:: bash
+
+ cargo install rst
+ rst README.rst
+ # or
+ cargo run -- README.rst
This project is dual-licensed under Apache 2.0 and MIT.