summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/sagetex/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/sagetex/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/sagetex/README')
-rw-r--r--macros/latex/contrib/sagetex/README53
1 files changed, 53 insertions, 0 deletions
diff --git a/macros/latex/contrib/sagetex/README b/macros/latex/contrib/sagetex/README
new file mode 100644
index 0000000000..fb35a8b4e8
--- /dev/null
+++ b/macros/latex/contrib/sagetex/README
@@ -0,0 +1,53 @@
+This is the SageTeX package. It allows you to embed code, results of
+computations, and plots from the Sage mathematics software suite
+(http://sagemath.org) into LaTeX documents.
+====================================================================
+
+SageTeX is included with Sage, so to use it, you only need to make the
+file sagetex.sty known to TeX; that file will be in
+SAGE_ROOT/local/share/texmf/tex/latex/sagetex, along with
+documentation and examples. See the Sage tutorial at
+http://doc.sagemath.org/html/en/tutorial/sagetex.html
+for a quick usage introduction, and for complete installation
+instructions later on the same page at
+http://doc.sagemath.org/html/en/tutorial/sagetex.html#sec-sagetex-install
+
+The complete documentation is in sagetex.pdf, in
+the SAGE_ROOT/... directory mentioned above.
+
+If you want to extract any of SageTeX's files from the .dtx sources, you
+can do
+
+ 0. Run `latex sagetex.ins'
+
+To regenerate the documentation, do
+
+ 1. Run `latex sagetex.dtx'
+ 2. Run `sage sagetex.sage'
+ 3. Run the indexing commands that the .ins file told you about.
+ 4. Run `latex sagetex.dtx' again.
+
+You can skip step 3 if you don't care about the index. You will need the
+pgf and tikz packages installed to typeset the figures.
+
+The file example.tex has, as you likely guessed, a bunch of examples
+showing you how this package works. You can compile it using a another
+latex-sage-latex cycle as in steps 1-2-4 above. Note that example.tex
+includes some PNG graphics which latex cannot use; to see those, use
+pdflatex instead of regular latex or enable the imagemagick option. (See
+the documentation.)
+
+To use the SageTeX package with your own documents, see the
+"Installation" section of the documentation.
+
+This work builds on a lot of work by others; see the CONTRIBUTORS file
+and the "Credits" section of the documentation for credits. The source
+code may be modified and distributed under the terms of the GPL, version
+2 or later; the documentation may be modified and distributed under a
+Creative Commons Attribution - Share Alike 3.0 License. See the "Copying
+and licenses" section of the documentation.
+
+Please let me know if you find any bugs or have any ideas for
+improvement!
+
+- Dan Drake <dr.dan.drake at gmail>