Permalink
Browse files

get ready to write embedding-HOWTO.md

  • Loading branch information...
1 parent 17d2930 commit 2216e848b6aa6c4b0fdba58b542ab0a4e8827d3e Philip Guo committed Oct 1, 2012
Showing with 24 additions and 6 deletions.
  1. +20 −0 v3/docs/embedding-HOWTO.md
  2. +3 −5 v3/docs/embedding-HOWTO.txt
  3. +1 −1 v3/index.html
@@ -0,0 +1,20 @@
+# Embedding Online Python Tutor visualizations
+
+This document is a starting point for anyone who wants to embed
+Online Python Tutor (OPT) visualizations in their webpage. View it online at:
+
+https://github.com/pgbovine/OnlinePythonTutor/blob/master/v3/docs/embedd.md
+
+Look at the Git history to see when this document was last updated; the more time
+elapsed since that date, the more likely things are out-of-date.
+
+I'm assuming that you're competent in Python, JavaScript, command-line-fu, and Google-fu,
+so I won't do much hand-holding in these directions.
+
+This guide isn't meant to be comprehensive; you will undoubtedly still
+be confused about details after reading it, so feel free to email
+philip@pgbovine.net if you have questions.
+
+And please excuse the sloppy writing; I'm not trying to win any style awards here :)
+
+
@@ -1,6 +1,4 @@
-Instructions for embedding Online Python Tutor visualizations
-------
+This document has been moved to embedding-HOWTO.md
-[Full documentation coming soon! For now, please email philip@pgbovine.net]
-
-[TODO: move to GitHub Markdown format]
+View it online at:
+https://github.com/pgbovine/OnlinePythonTutor/blob/master/v3/docs/embedding-HOWTO.md
View
@@ -127,7 +127,7 @@
<h1><span id="embedHeading">EMBED</span> <span class="smallH1">visualizations in digital textbooks</span></h1>
<p>Using a single line of JavaScript code, you can <a
-href="docs/embedding-HOWTO.txt">embed</a> an Online Python Tutor
+href="https://github.com/pgbovine/OnlinePythonTutor/blob/master/v3/docs/embedding-HOWTO.md">embed</a> an Online Python Tutor
visualization within your web page (as shown in the &ldquo;Learn&rdquo;
box above). The screenshot below shows a few of these visualizations
embedded within the online textbook for the introductory CS course at UC

0 comments on commit 2216e84

Please sign in to comment.