1. activestate
  2. komodo-recipes

Source

komodo-recipes /

Filename Size Date modified Message
components
content
locale/en-US
pylib
skin
277 B
275 B
1.1 KB
2.8 KB
350 B
1.2 KB
1.6 KB
-*- restructuredtext -*-

========================
Komodo Recipes Extension
========================

------------------------------
What is the Recipes Extension?
------------------------------

The Komodo Recipes Extension provides an easy way to paste recipes from
`ActiveState Code`_ into an open buffer in `ActiveState Komodo`_.

.. _ActiveState Code: http://code.activestate.com/
.. _ActiveState Komodo: http://www.activestate.com/komodo/

------------
Installation
------------

In Komodo you can install the extension under *Tools* > *Add-ons*. If you have
an ``.xpi`` file just drop it into the Add-ons dialog to install it. You should
find a relatively up-to-date version of the XPI in the downloads section on the
`project downloads page`_. After installing the extension you should be able to
open it under *Tools* > *Insert recipe...*.

.. _project downloads page: http://bitbucket.org/activestate/komodo-recipes/downloads/

----------
How to use
----------

To insert a recipe into the current buffer in Komodo, open the extension under
*Tools* > *Insert recipe...*. You will see a dialog with a search field and a
result list. To search for a recipe enter words or word fragments separated by
spaces. You can also search for tags by prepending a hash sign (``#``) to the
tag name.

------------
How to build
------------

The recipes extension can be build using the *koext build* command from the
Komodo SDK. Before you build the extension make sure that there is a *pylib*
directory which contains another *recipeslib* directory which you can find in
the `python-recipes`_ project. 

.. _python-recipes: http://bitbucket.org/activestate/python-recipes/

-------
License
-------

**The MIT License**

Copyright (c) 2010 ActiveState Software Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.