aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..678386a
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,46 @@
+=============================
+ reStructuredText per esempi
+=============================
+
+Requisiti e compilazione
+------------------------
+
+Per compilare gli esempi in vari formati sono necessari python 2.x
+e docutils_. Inoltre per il formato pdf è necessaria una distribuzione
+di TeX completa di xeTeX, ad esempio `TeX Live`_.
+
+.. _docutils: http://docutils.sourceforge.net/
+.. _`TeX Live`: http://www.tug.org/texlive/
+
+Tutti i documenti possono essere compilati in vari formati con
+i programmi rst2* di docutils, ma per semplicità si può usare::
+
+ ./build.py [-H] [-p] [-o] <sezione> [<sezione>]
+
+dove ``-H``, ``-p`` e ``-o`` compilano rispettivamente in html, pdf
+ed odt, e ``<sezione>`` può essere ``esempi`` o ``strumenti``.
+
+Alcuni esempi non compilano in tutti i formati supportati da
+docutils, dato che illustrano caratteristiche non sempre disponibili.
+
+In alternativa, si possono compilare gli esempi con pandoc_, usando::
+
+ ./pandoc_build.sh [-H] [-l] [-p] [-e] <sezione> [<sezione>]
+
+anche in questo caso per ottenere PDF è necessario avere installato
+xeTeX.
+
+.. _pandoc: http://johnmacfarlane.net/pandoc/
+
+Licenza
+-------
+
+Copyright (C) 2012 Elena Grandi
+
+Quest'opera è stata rilasciata con licenza Creative Commons Attribuzione -
+Condividi allo stesso modo 3.0 Italia. Per leggere una copia della licenza
+visita il sito web `<http://creativecommons.org/licenses/by-sa/3.0/it/>`_ o
+spedisci una lettera a Creative Commons, 171 Second Street, Suite 300, San
+Francisco, California, 94105, USA.
+
+