Please sign in to comment.
Adding text to README.md.
- Loading branch information...
|@@ -1,4 +1,39 @@|
|+## Plugin installation|
|+The IPython Notebook allows the user to provide their own assets in the `static` directory of any IPython profile. The `static` directory has a special subdirectory, `jsplugins`, where you can install your plugins. As a concrete example, let say you have a plugin with the following structure:|
|+To install this, you would simply cp this into your `/static/jsplugins` directory:|
|+ $ cp -r myplugin ~/.ipython/profile_default/static/jsplugins|
|+There are situations where a plugin will require additional Python code to work properly. In these cases, you should install that Python code just like you would any other Python code. Either run `setup.py install` or put it somewhere on your `PYTHONPATH`. If the code is an IPython extension, you can copy it into `~./ipython/extensions`.|
|+## Plugin development|
|+To create a plug in you should go through the following steps:|
|+1. Clone this repository and create a branch.|
|+2. Create a subdirectory for your plugin.|
|+4. You may also want to include Python code in your plugin.|
|+4. Create a README.md that describes the plugin along with instructions for its installation.|
|+5. Send us a pull request.|
|+Have a look at our existing plugins for examples.|