summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/sagetex/README
blob: 2e9d512d0eb746fc25928003bb71873b2a78e517 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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.
====================================================================

To use SageTeX, you need the files sagetex.sty and sagetex.py. If those
haven't been extracted from the .dtx file, you'll need to do:

  0. Run `latex sagetexpackage.ins'

If a PDF file of the documentation wasn't included with this
distribution of SageTex, you will need to build the documentation
yourself. To do that:

  1. Run `latex sagetexpackage.dtx'
  2. Run `sage sagetexpackage.sage'
  3. Run the indexing commands that the .ins file told you about.
  4. Run `latex sagetexpackage.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 works builds on a lot of work by others; see the "Credits" section
of the documentation for credits. The source code may be modified and
distributed under the terms of the GPL, v2 or later; the documentation
may be modified and distributed under a Creative Commons Attribution -
Noncommercial - 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 <ddrake@member.ams.org>