www

commit a86743baa900935bca61fd3020efa06232cbed21
parent 4fed397bb96c67d252233330795891979e6604c5
Author: Georges Dupéron <georges.duperon@gmail.com>
Date:   Wed, 14 Dec 2016 20:19:50 +0100

Filled in README

Diffstat:
M
README.md
 | 
40
+++++++++++++++++++++++++++++++++++++++-

1 file changed, 39 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,3 +1,40 @@
+[![Build Status,](https://img.shields.io/travis/jsmaniac/debug-scopes/master.svg)](https://travis-ci.org/jsmaniac/debug-scopes)
+[![Coverage Status,](https://img.shields.io/coveralls/jsmaniac/debug-scopes/master.svg)](https://coveralls.io/github/jsmaniac/debug-scopes)
+[![Build Stats,](https://img.shields.io/badge/build-stats-blue.svg)](http://jsmaniac.github.io/travis-stats/#jsmaniac/debug-scopes)
+[![Online Documentation.](https://img.shields.io/badge/docs-online-blue.svg)](http://docs.racket-lang.org/debug-scopes/)
+
 debug-scopes
 ============
-README text here.
+
+Some utilities which help debugging scope-related issues with Racket
+unhygienic macros (hygienic macros in Racket will likely not need these
+utilities).
+
+First, run:
+
+    raco pkg install debug-scopes
+
+Then, require one or several of the following modules:
+
+    (require debug-scopes)
+
+* `(+scopes stx)` returns a string with a succinct representation of which
+  scopes are present on each identifier.
+* `(print-full-scopes)` prints the long version of the scope information for
+  the scopes used in preceeding calls to `+scopes`.
+
+    (require debug-scopes/named-scopes)
+
+* (make-named-scope string-or-symbol) creates a scope similarly to
+  `make-syntax-introducer`, but annotates it with a name. This is a hack which
+  creates a module with that name, and extracts the module scope (since these
+  scopes have names attached to them in Racket). As a result, with the current
+  implementation, this returns a module scope instead of a macro scope like
+  `make-syntax-introducer`.
+
+    (require debug-scopes/named-scopes/override)
+
+* Overrides `define-syntax` and `syntax-local-introduce`. The overridden
+  `syntax-local-introduce` works with the overridden `define-syntax` to flip a
+  named scope instead of the usual macro scope. The use-site scope which may
+  be flipped by `syntax-local-introduce` is left unchanged.
+\ No newline at end of file