diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 56 |
1 files changed, 47 insertions, 9 deletions
diff --git a/README.rst b/README.rst index a3458028b..41da33fcb 100644 --- a/README.rst +++ b/README.rst @@ -1,17 +1,55 @@ Pyramid ======= -Pyramid is a small, fast, down-to-earth, open source Python web framework. -It makes real-world web application development and -deployment more fun, more predictable, and more productive. +.. image:: https://travis-ci.org/Pylons/pyramid.png?branch=master + :target: https://travis-ci.org/Pylons/pyramid + :alt: master Travis CI Status -Pyramid is produced by the `Pylons Project <http://pylonsproject.org/>`_. +.. image:: https://readthedocs.org/projects/pyramid/badge/?version=master + :target: https://docs.pylonsproject.org/projects/pyramid/en/master + :alt: master Documentation Status + +.. image:: https://img.shields.io/badge/irc-freenode-blue.svg + :target: https://webchat.freenode.net/?channels=pyramid + :alt: IRC Freenode + +`Pyramid <https://trypyramid.com/>`_ is a small, fast, down-to-earth, open +source Python web framework. It makes real-world web application development +and deployment more fun, more predictable, and more productive. + +.. code-block:: python + + from wsgiref.simple_server import make_server + from pyramid.config import Configurator + from pyramid.response import Response + + def hello_world(request): + return Response('Hello World!') + + if __name__ == '__main__': + with Configurator() as config: + config.add_route('hello', '/') + config.add_view(hello_world, route_name='hello') + app = config.make_wsgi_app() + server = make_server('0.0.0.0', 6543, app) + server.serve_forever() + +Pyramid is a project of the `Pylons Project <https://pylonsproject.org>`_. Support and Documentation ------------------------- -See the `Pylons Project website <http://pylonsproject.org/>`_ to view -documentation, report bugs, and obtain support. +See `Pyramid Support and Development +<https://docs.pylonsproject.org/projects/pyramid/en/latest/#support-and-development>`_ +for documentation, reporting bugs, and getting support. + +Developing and Contributing +--------------------------- + +See `HACKING.txt <https://github.com/Pylons/pyramid/blob/master/HACKING.txt>`_ and +`contributing.md <https://github.com/Pylons/pyramid/blob/master/contributing.md>`_ +for guidelines on running tests, adding features, coding style, and updating +documentation when developing in or contributing to Pyramid. License ------- @@ -22,6 +60,6 @@ Pyramid is offered under the BSD-derived `Repoze Public License Authors ------- -Pyramid is made available by `Agendaless Consulting <http://agendaless.com>`_ -and a team of contributors. - +Pyramid is made available by `Agendaless Consulting <https://agendaless.com>`_ +and a team of `contributors +<https://github.com/Pylons/pyramid/graphs/contributors>`_. |