aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLudovic Court`es2007-06-11 16:01:23 +0000
committerLudovic Court`es2007-06-11 16:01:23 +0000
commit051298e40f8b74f10bd1bc446437709cfb0979af (patch)
tree90e8b468baa510de38d86675ba09e579033750eb /README
parentd558f49f502ed9fa21ee75f75ef53490cf0a48ea (diff)
parent1f48b0b69eda0e6b4262d69a77c6adbc13887159 (diff)
downloadskribilo-051298e40f8b74f10bd1bc446437709cfb0979af.tar.gz
skribilo-051298e40f8b74f10bd1bc446437709cfb0979af.tar.lz
skribilo-051298e40f8b74f10bd1bc446437709cfb0979af.zip
Updated the top-level documentation files.
* configure.ac: Changed the bug report address to `skribilo-users@nongnu.org'. git-archimport-id: skribilo@sv.gnu.org--2006/skribilo--devo--1.2--patch-114
Diffstat (limited to 'README')
-rw-r--r--README94
1 files changed, 52 insertions, 42 deletions
diff --git a/README b/README
index db68b22..596d75a 100644
--- a/README
+++ b/README
@@ -1,69 +1,79 @@
-What is Skribe
-**************
+Skribilo
+========
-Skribe is programming language design for the production of electronic
-documents. With Skribe one can:
-
- - Produce HTML web pages.
- - Produce PS files.
- - ...
+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.
-One may also:
+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.
- - Translate Texinfo files into HTML.
+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.
- - re-use BibTex bibliography databases.
+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:
-Obtaining Skribe
-****************
+ http://www.nongnu.org/skribilo/
-New versions of Skribe may downloaded from:
- ftp://ftp-sop.inria.fr/mimosa/fp/Skribe
+Requirements
+............
+You need at least:
-Skribe distrubtion
-******************
+ * GNU Guile >= 1.8.x
+ http://www.gnu.org/software/guile/
-The Skribe distribution consists of several directories:
+ * Guile-Reader >= 0.3
+ http://www.nongnu.org/guile-reader/
- INSTALL installation instructions.
+ * Guile-Lib (any version)
+ http://home.gna.org/guile-lib/
- Makefile the Makefile to compile Skribe.
+Optionally, you may want to install one of the following document layout
+programs to produce PS/PDF files:
- README this document.
+ * Lout
+ http://lout.sourceforge.net/
- README.java specific information regarding the JVM port of Skribe.
+ * LaTeX
+ http://www.latex-project.org/
- etc private directory.
+ * ConTeXt
+ http://www.pragma-ade.nl/
- bin the directory where binary files are compiled to.
+Optionally, to produce pie charts, you may want to use:
- lib the directory where Skribe libraries are compiled to.
+ * Ploticus
+ http://ploticus.sourceforge.net/
- configure configuration driver script.
-
- emacs Skribe emacs mode.
+This is it!
- examples Various example of Skribe texts.
- doc the Skribe sources for Skribe manuals.
+History
+.......
- src the Scheme source code for Skribe.
+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:
- skr the Skribe source code for the Skribe engines and styles.
+ http://www-sop.inria.fr/mimosa/fp/Skribe/
- tools the Bigloo source code for the Texi->Skribe and BibTex->Skribe
- compilers.
+I am thankful to them for implementing Skribe!
-Acknowledgements
-****************
+June 2007,
+Ludovic Courtès <ludo@chbouib.org>.
-We thank all the people who helped me while writing Skribe. My first
-though goes to Frederic Boussinot who's the first pre-alpha-tester of
-Skribe always volunteering for new testing new features ;-) I then
-thanks all the people that send me fixes, suggestions and
-improvements, that is, all the people that appear in the ChangeLog
-file. Many thanks to all of you.
+;;; Local Variables:
+;;; mode: text
+;;; coding: utf-8
+;;; End: