Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

readme change

  • Loading branch information...
commit 52551ec6e991c63b57530ea18ad90bcc0cbf945b 1 parent a242823
@yinwang0 authored
Showing with 27 additions and 6 deletions.
  1. +27 −6 README
View
33 README
@@ -1,15 +1,36 @@
-* How to build and use
+* INSTALLATION
ydiff is implemented in Scheme. The Scheme implementation used for
this project is Racket. You can get it from http://racket-lang.org.
-Currently there is no Unix command line interface. In order to use it,
-you need to load the 'diff-<lang>.ss' files in the Racket repl before
-invoking the diff-<lang> functions. For example:
+To build it, go to the directory containing the source and run "make".
+It should compile to several executables, such as "diff-scheme",
+"diff-cpp" etc. Copy those files to some directory in your PATH.
-(load "diff-scheme.ss")
-(diff-scheme "file1.ss" "file2.ss")
+
+* USAGE
+
+1. Run commands like:
+
+ diff-scheme demos/mk.scm demos/mk-c.scm
+
+It will produce a HTML file named "file1-file2.html" in the current
+directory.
+
+
+2. Copy the support files "diff-s.css" and "nav-div.js" to the current
+directory, then use your browser to open the HTML file. You can scroll
+the file and click on the names to see the interactive effects.
+
+NOTICE: If you use Chrome, the JavaScript will not run on local files,
+so you may need to install a web server on your machine to view the
+file correctly. I recommend mongoose:
+
+ http://code.google.com/p/mongoose
+
+Just put the executable in your directory and run it, then visit
+"localhost:8080". Have fun!
Please sign in to comment.
Something went wrong with that request. Please try again.