commit 7b3b27cf0f02a2bb3409657572919be21226c62f
parent 92adcde5d4475f7eb9656a23d2a7a7d6e64bb07e
Author: Georges Dupéron <georges.duperon@gmail.com>
Date: Wed, 30 Mar 2016 18:02:53 +0200
Improved README file
Diffstat:
2 files changed, 36 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,37 @@
REPLtest
========
-This package provides the `#lang repltest` meta-language, which can be used to turn the transcript of an interactive racket session into a series of tests.
-\ No newline at end of file
+This package provides the `#lang repltest` meta-language, which can be used to turn the transcript of an interactive racket session into a series of tests.
+
+Usage:
+
+```
+raco pkg install repltest
+```
+
+Then write a file using the repltest meta-language, containing definitions at the top and interactions after the first prompt (by default the prompt is `"> "`, I will add customization options later).
+
+```
+#lang debug repltest typed/racket
+;; There is a problem if there is a comment before a prompt, as comments aren't
+;; gobbled-up by the preceeding read.
+(define x 0)
+(define y 1)
+'displayed
+(displayln "displayed too")
+
+> (+ 1 1)
+- : Integer [more precisely: Positive-Index]
+2
+> x
+- : Integer [more precisely: Zero]
+0
+> (values x y)
+- : (values Integer Integer) [more precisely: (Values Zero One)]
+0
+1
+> #R(+ 2 0)
+(+ 2 0) = 2
+- : Integer [more precisely: Positive-Byte]
+2
+```
+\ No newline at end of file
diff --git a/main.rkt b/main.rkt
@@ -1,7 +1,6 @@
#lang racket/base
-(module+ test
- (require rackunit))
+;; This package is a meta-language, and currently provides no bindings.
;; Notice
;; To install (from within the package directory):
@@ -24,12 +23,3 @@
;; See the current version of the racket style guide here:
;; http://docs.racket-lang.org/style/index.html
-;; Code here
-
-(module+ test
- ;; Tests to be run with raco test
- )
-
-(module+ main
- ;; Main entry point, executed when run with the `racket` executable or DrRacket.
- )
