documentation

daveagp · daveagp · commit 24903a198ed2 · 2015-06-21T16:44:54.000-07:00
diff --git a/cpp_visualizer.txt b/cpp_visualizer.txt
@@ -71,6 +71,10 @@ being similar to Java; you could use this to fake-visualize any
 other language depending on how much work you're willing to put into writing
 2 parallel versions of the code.
 
+The Java/C++ embedded visualizer is using a modification of an old version
+of the embedded visualizer code. See embed/README for details. It would
+be nice to bring it up to date.
+
 A few educators and students that I have talked to have ideas and partial
 implementations of a "real" C++ visualizer, either by piping through gdb,
 or by using LLDB's API, or by doing something like valgrind. Please email
diff --git a/embed/README b/embed/README
@@ -1,4 +1,17 @@
-modified from
-https://github.com/cemc/cscircles-wp-content:
-directory
-plugins/pybox/OnlinePythonTutor3-cemc
+Note! This repository is using a crufty old version of the visualizer
+for embedding.
+
+The reason for this is laziness, but specifically because there are
+features of the Java Visualizer not yet supported on the main branch and
+at pythontutor.com (as of the date of writing), in particular
+command-line arguments and standard input.
+
+As a result, this subdirectory has out-of-date copies from an old
+version of the Python Tutor, which were then manually changed to be
+Java-friendly. 
+
+For reference, the files in this directry were taken from 
+https://github.com/cemc/cscircles-wp-content
+in the directory pybox/OnlinePythonTutor3-cemc
+and then modified.
+
