summaryrefslogtreecommitdiff
path: root/README
blob: d10f6365e298114c8e6f6c56a5b1816b97aaaeba (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
Skribilo
========

Skribilo is a document authoring system allowing users to produce
documents in a variety of formats (HTML, PostScript, PDF, XML, etc.)
from a single source document, while still retaining fine-grain control
over the output.

Beside rudimentary features provided by the `base' package, Skribilo
provides packages for the production of colored program source code,
bibliographies, pie charts, mathematical equations, and more.

Skribilo is based on the Scheme programming language and is highly
extensible: it is easy to define new documentation primitives (called
"markups") and their rendering in each output format.

Skribilo's core is written in mostly-portable Scheme (i.e., uses
standard APIs such as SRFIs rather than Guile-specific APIs whenever
that is possible), making it intelligible and hackable for most Scheme
programmers.

For more information, see:

  http://www.nongnu.org/skribilo/


Requirements
............

You need at least:

  * GNU Guile >= 2.0.x
    http://www.gnu.org/software/guile/

  * Guile-Reader >= 0.6
    http://www.nongnu.org/guile-reader/

  * ImageMagick, used to convert images from one format to another
    http://imagemagick.org/

Optionally, you may want to install one of the following document layout
programs to produce PS/PDF files:

  * Lout
    http://lout.sourceforge.net/

  * LaTeX
    http://www.latex-project.org/

  * ConTeXt
    http://www.pragma-ade.nl/

To produce pie charts, you may want to use:

  * Ploticus
    http://ploticus.sourceforge.net/

To convert images in the `fig' format:

  * Xfig, Transfig
    http://xfig.org/

To be able to use the `rss-2' reader, you will need:

  * Guile-Lib (specifically, `sxml' and `htmlprag' modules)
    http://www.nongnu.org/guile-lib/

This is it!


Development
...........

A copy of the source code repository can be obtained with Git
(http://git.or.cz/), using the following incantation:

  git clone git://git.sv.gnu.org/skribilo.git

You can then send patches to the <skribilo-users@nongnu.org> mailing
list!


History
.......

Skribilo is based on the Skribe code base, written by Manuel Serrano and
Erick Gallesio.  See `README.Skribe' for the original Skribe `README'
file, or visit:

  http://www-sop.inria.fr/mimosa/fp/Skribe/

I am thankful to them for implementing Skribe!


June 2007,
Ludovic Courtès <ludo@chbouib.org>.



Copyright 2007, 2008, 2012  Ludovic Courtès <ludo@gnu.org>

  Copying and distribution of this file, with or without modification,
  are permitted in any medium without royalty provided the copyright
  notice and this notice are preserved.

;;; Local Variables:
;;; mode: text
;;; coding: utf-8
;;; End: