Merge pull request #18 from RunestoneInteractive/master

Updating master

Author: flysaiah

.gitignore

@@ -35,3 +35,5 @@ nosetests.xml
 .project
 .pydevproject
 .idea
+bower_componenets/
+test/

README.rst

@@ -1,6 +1,10 @@
 RunestoneComponents
 ===================
 
+.. image:: https://badges.gitter.im/Join%20Chat.svg
+   :alt: Join the chat at https://gitter.im/RunestoneInteractive/RunestoneComponents
+   :target: https://gitter.im/RunestoneInteractive/RunestoneComponents?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
 Packaging of the Runestone components for publishing educational materials using Sphinx and restructuredText. Check out the `Overview <http://interactivepython.org/runestone/static/overview/overview.html>`_ To see all of the extensions in action.
 **NOTE** -- If you have used an older version of this repo, please know this is a total restart.  I think much better, and it WILL stay up to date as this is now the master copy of the components not just a copy.
 Check out the `Development Roadmap <https://github.com/bnmnetp/runestone/wiki>`_ to get an understanding of our migration towards webcomponents.
@@ -17,6 +21,13 @@ If you are completely new to pip and github text editors, I have written a more
 
     pip install runestone
 
+On some versions of pip that will fail and you need to use:
+
+::
+
+    pip install --pre runestone
+
+
 
 Or, if you prefer to live on the development edge, you can check out the very latest from:
 
@@ -59,6 +70,20 @@ installation every so often.  If you are new to using Python on windows I recomm
 link on `Using Python with Windows <https://docs.python.org/3.4/using/windows.html>`_
 
 
+Developing and Hacking
+----------------------
+
+So, you would like to help out with developing the Runestone Components.  What do you need to know?
+
+1.  Make a Fork of this repository.
+2.  Setup your environment on your development machine
+
+    1.  Make a virtual environment for testing and working  I recommend pyvenv-3.4  as it is baked in to Python 3.4 and higher.
+    2.  Rather than following the instructions above for installing runestone simply run ``pip install .`` from the top level runestone directory.  This will install all of the required prerequisites and setup the runestone install as a link to the development directory.
+
+3.  When you have some changes to share, make a Pull Request.
+
+
 Notes for more Advanced Users
 -----------------------------
 
@@ -69,4 +94,4 @@ If you already have an existing `Sphinx <http://sphinx-doc.org>`_  project and y
 * Then modify your html_static_path:  ``html_static_path = ['_static']  + runestone_static_dirs()``  Again you may have your own set of static paths in the initial list.
 
 
-See https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap to get a sense for how this is all going to come together.
+See https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap to get a sense for how this is all going to come together.

runestone/activecode/README.md

@@ -0,0 +1,32 @@
+### activecode
+
+```html
+<pre data-component="activecode" id="example1" data-lang="python">
+def main()
+    print("hello world")
+    
+main()
+</pre>
+```
+
+The body of the ``pre`` tag contains code to be loaded into the editor initially.  The following attributes are options and control what pieces and parts of the component will be visible.
+
+* ``data-component`` attribute identifies this as an activecode component
+* ``class``  The usual CSS class options
+* ``id`` must be unique in the document
+* ``data-lang`` for activecode can be python javascript or html
+* ``data-autorun`` run this activecode as soon as the page is loaded
+* ``data-hidecode`` make the editor hidden initially
+* ``data-include`` list of ids of other activecodes.  The code form each will be prepended to the code to run
+* ``data-timelimit`` either False to turn off runtime limit checking or an integer representing the number of milliseconds until timeout.
+* ``data-coach``  add a button to display code coach information
+* ``data-codelens`` add a button "Run this in Codelens"
+
+
+For Python to work in the browser you must also obtain and include via a script tag ``skulpt.min.js`` and 
+``skulpt-stdlib.js`` along with ``codemirror.js`` and of course ``activecode.js``
+
+Soon, many of these requirements will be incorporated into one handy ``runestone.js`` file.
+
+
+