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.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11481
10df276abb78 [doc] Escape _ in README.md
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11479
diff changeset
     1
[pyramid\_cubicweb][] is one specific way of integrating [CubicWeb][] with a
11479
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     2
[Pyramid][] web application.
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     3
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     4
### Features
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     5
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     6
* provides a default route that let a cubicweb instance handle the request.
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     7
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     8
### Usage
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
     9
11481
10df276abb78 [doc] Escape _ in README.md
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11479
diff changeset
    10
To use, install pyramid\_cubicweb in your python environment,
11479
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    11
and then [include][] the package:
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    12
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    13
    config.include('pyramid_cubicweb')
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    14
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    15
### Configuration
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    16
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    17
Requires the following [INI setting / environment variable][]:
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    18
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    19
* `cubicweb.instance` / `CUBICWEB_INSTANCE`
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    20
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    21
11481
10df276abb78 [doc] Escape _ in README.md
Denis Laxalde <denis.laxalde@logilab.fr>
parents: 11479
diff changeset
    22
[pyramid\_cubicweb]: https://www.cubicweb.org/project/pyramid-cubicweb
11479
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    23
[CubicWeb]: http://www.cubicweb.com/
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    24
[Pyramid]: http://pypi.python.org/pypi/pyramid
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    25
[include]: http://docs.pylonsproject.org/projects/pyramid/en/latest/api/config.html#pyramid.config.Configurator.include
a070f211b35c Project Structure
Christophe de Vienne <christophe@unlish.com>
parents:
diff changeset
    26
[INI setting / environment variable]: http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html#adding-a-custom-setting