README.md
author Denis Laxalde <denis.laxalde@logilab.fr>
Fri, 12 Sep 2014 09:28:32 +0200
changeset 11481 10df276abb78
parent 11479 a070f211b35c
permissions -rw-r--r--
[doc] Escape _ in README.md So that the Markdown is okay.

[pyramid\_cubicweb][] is one specific way of integrating [CubicWeb][] with a
[Pyramid][] web application.

### Features

* provides a default route that let a cubicweb instance handle the request.

### Usage

To use, install pyramid\_cubicweb in your python environment,
and then [include][] the package:

    config.include('pyramid_cubicweb')

### Configuration

Requires the following [INI setting / environment variable][]:

* `cubicweb.instance` / `CUBICWEB_INSTANCE`


[pyramid\_cubicweb]: https://www.cubicweb.org/project/pyramid-cubicweb
[CubicWeb]: http://www.cubicweb.com/
[Pyramid]: http://pypi.python.org/pypi/pyramid
[include]: http://docs.pylonsproject.org/projects/pyramid/en/latest/api/config.html#pyramid.config.Configurator.include
[INI setting / environment variable]: http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html#adding-a-custom-setting