Permalink
Browse files

Update README with basic info on using local mode

Test plan: Daily for the last year

Auditors: alpert
  • Loading branch information...
1 parent 401f055 commit bb43f8804398b98b84f13208f0ad990e4708d151 @beneater beneater committed Dec 10, 2012
Showing with 11 additions and 0 deletions.
  1. +11 −0 README.md
View
@@ -15,6 +15,17 @@ The framework exists in two components:
* An HTML markup for specifying exercises.
* A jQuery plugin for generating a usable, interactive, exercise from the HTML markup.
+
+## Using the Framework Locally
+
+You need to serve the files from some sort of a server. You can't just open the files directly in a browser:
+
+ cd khan-exercises
+ python -m SimpleHTTPServer # or python3 -m http.server
+
+Now if you open your browser to `http://localhost:8000` (or `http://127.0.0.1:8000/`) you should see the contents of the `khan-exercises` directory. Navigate to the `exercises` subfolder, and an HTML file under there to see an exercise.
+
+
## Writing Exercises
The process for writing exercises is rather well documented. More information about this process can be found in the [Khan Exercises wiki](https://github.com/Khan/khan-exercises/wiki). Specifically:

0 comments on commit bb43f88

Please sign in to comment.