Documentation tweak
authorFrancois-Rene Rideau <fare@tunes.org>
Mon, 14 Nov 2011 20:49:47 +0000 (15:49 -0500)
committerFrancois-Rene Rideau <fare@tunes.org>
Mon, 14 Nov 2011 20:49:47 +0000 (15:49 -0500)
README
scribble.asd

diff --git a/README b/README
index a611ba9..ae44574 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 Scribble: SCRibe-like reader extension for Common Lisp
-Copyright (c) 2002-2010 by Fare Rideau < fare at tunes dot org >
+Copyright (c) 2002-2011 by Fare Rideau < fare at tunes dot org >
        http://www.cliki.net/Fare%20Rideau
 
 HOME PAGE:
@@ -11,12 +11,22 @@ You may at your leisure use the LLGPL instead:
        http://www.cliki.net/LLGPL
 
 DEPENDENCY:
-This package depends on Meta by Jochen Schmidt, version 0.1.1 or later.
+This package depends on Meta by Jochen Schmidt, version 1.0.0 or later.
        http://www.cliki.net/Meta
 Now also: closer-mop meta fare-utils fare-matcher
 
 USAGE:
-You can enable behaviour for the macro-character #\[ with
+You can enable Racket-like Scribble behavior for the macro-character #\@ with
+       (scribble:enable-scribble-at-syntax)
+and disable it with
+       (scribble:disable-scribble-at-syntax)
+For details, see:
+       http://docs.racket-lang.org/scribble/reader.html
+
+If you additionally pass the keyword argument :scribe t
+You will also have Skribe-like syntax.
+
+You can enable only Skribe-like syntax for the macro-character #\[ with
        (scribble:enable-scribble-syntax)
 and disable it with
        (scribble:disable-scribble-syntax)
@@ -25,13 +35,6 @@ under the dispatching macro-character #\# using
        (scribble:enable-sub-scribble-syntax)
        (scribble:disable-sub-scribble-syntax)
 
-New! You can instead enable Racket-like Scribble syntax for the macro-character #\@ with
-       (scribble:enable-scribble-at-syntax)
-and disable it with
-       (scribble:disable-scribble-at-syntax)
-For details, see:
-       http://docs.racket-lang.org/scribble/reader.html
-
 
 BASIC SYNTAX:
 The syntax of text within brackets is Scribe-like:
index d75d12f..ee035e5 100644 (file)
@@ -1,10 +1,13 @@
 ;;; -*- Lisp -*-
-(in-package :keyword)
-
-(asdf:defsystem scribble
-  depends-on (#|closer-mop|# meta fare-utils fare-matcher)
-  serial t
-  components (;;(file "ll")
-              (file "package")
-              (file "scribble-scribe")
-             (file "scribble")))
+(defsystem scribble
+  :description "Syntax extensions akin to Racket's Scribble and Bigloo's Skribe"
+  :long-description "Scribble offers two syntax extensions allowing you to very nicely
+mix text markup data and Lisp code. One syntax is a port to CL of Racket's Scribble syntax,
+and the other is a port to CL of Bigloo's Skribe syntax."
+  :depends-on (#|:closer-mop|# :meta :fare-utils :fare-matcher)
+  :serial t
+  :components
+  (;;(file "ll")
+   (:file "package")
+   (:file "scribble-scribe")
+   (:file "scribble")))