From fb9b9f106699b38bc49c14c751d1b948a3c08533 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 11 Dec 2015 03:33:37 -0800 Subject: add developing and contributing section - wrap to 79 columns --- README.rst | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index e99133441..fed4534a0 100644 --- a/README.rst +++ b/README.rst @@ -16,9 +16,9 @@ Pyramid :target: https://webchat.freenode.net/?channels=pyramid :alt: IRC Freenode -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. +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. Pyramid is produced by the `Pylons Project `_. @@ -28,6 +28,13 @@ Support and Documentation See the `Pylons Project website `_ to view documentation, report bugs, and obtain support. +Developing and Contributing +--------------------------- + +See `HACKING.txt` and `contributing.md` for guidelines for running tests, +adding features, coding style, and updating documentation when developing in or +contributing to Pyramid. + License ------- -- cgit v1.2.3 From 4bd36e8669fece803ff8bb209e655ab16fb8c63b Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 11 Dec 2015 03:44:01 -0800 Subject: use double backticks for inline code formatting of filename --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index fed4534a0..2237d9950 100644 --- a/README.rst +++ b/README.rst @@ -31,7 +31,7 @@ documentation, report bugs, and obtain support. Developing and Contributing --------------------------- -See `HACKING.txt` and `contributing.md` for guidelines for running tests, +See ``HACKING.txt`` and ``contributing.md`` for guidelines for running tests, adding features, coding style, and updating documentation when developing in or contributing to Pyramid. -- cgit v1.2.3 From 9d16a111299601df3a2d1c22b4a6ca6044efcd3f Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 9 May 2016 01:16:54 -0700 Subject: add alt tag for Travis CI Status --- README.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 2237d9950..1b3e01b04 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,7 @@ Pyramid .. image:: https://travis-ci.org/Pylons/pyramid.png?branch=master :target: https://travis-ci.org/Pylons/pyramid + :alt: Master Travis CI Status .. image:: https://readthedocs.org/projects/pyramid/badge/?version=master :target: http://docs.pylonsproject.org/projects/pyramid/en/master/ -- cgit v1.2.3 From e8a994a75ddd46769c4d25d0cb64072a5bfaf53a Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 19 May 2016 21:49:44 -0700 Subject: update link to canonical location for support and documentation --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 1b3e01b04..dec7e03d0 100644 --- a/README.rst +++ b/README.rst @@ -26,8 +26,9 @@ Pyramid is produced by the `Pylons Project `_. Support and Documentation ------------------------- -See the `Pylons Project website `_ to view -documentation, report bugs, and obtain support. +See `Pyramid Support and Development +`_ +for documentation, reporting bugs, and getting support. Developing and Contributing --------------------------- -- cgit v1.2.3 From 1129435966dfb80f81ea9513867713e3cf248b49 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Tue, 7 Jun 2016 03:49:14 -0700 Subject: update links in readme --- README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index dec7e03d0..a9e38f636 100644 --- a/README.rst +++ b/README.rst @@ -17,11 +17,11 @@ Pyramid :target: https://webchat.freenode.net/?channels=pyramid :alt: IRC Freenode -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. +`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. -Pyramid is produced by the `Pylons Project `_. +Pyramid is a project of the `Pylons Project `_. Support and Documentation ------------------------- @@ -46,6 +46,6 @@ Pyramid is offered under the BSD-derived `Repoze Public License Authors ------- -Pyramid is made available by `Agendaless Consulting `_ -and a team of contributors. - +Pyramid is made available by `Agendaless Consulting `_ +and a team of `contributors +`_. -- cgit v1.2.3 From 7b536fa7164530f84683a9daae04c59009691941 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Fri, 10 Jun 2016 11:55:15 -0500 Subject: see how a code example looks in the readme --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index a9e38f636..35c335d9c 100644 --- a/README.rst +++ b/README.rst @@ -21,6 +21,23 @@ Pyramid 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 %(name)s!' % request.matchdict) + + if __name__ == '__main__': + config = Configurator() + config.add_route('hello', '/hello/{name}') + config.add_view(hello_world, route_name='hello') + app = config.make_wsgi_app() + server = make_server('0.0.0.0', 8080, app) + server.serve_forever() + Pyramid is a project of the `Pylons Project `_. Support and Documentation -- cgit v1.2.3 From 2b8c7d5e418b2d5df0e05508ae9c17168b30f28d Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Wed, 6 Jul 2016 22:05:34 -0500 Subject: link to hacking and contributing --- README.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 35c335d9c..6ef75e899 100644 --- a/README.rst +++ b/README.rst @@ -50,9 +50,10 @@ for documentation, reporting bugs, and getting support. Developing and Contributing --------------------------- -See ``HACKING.txt`` and ``contributing.md`` for guidelines for running tests, -adding features, coding style, and updating documentation when developing in or -contributing to Pyramid. +See `HACKING.txt `_ and +`contributing.md `_ +for guidelines on running tests, adding features, coding style, and updating +documentation when developing in or contributing to Pyramid. License ------- -- cgit v1.2.3