docs/README.txt
changeset 47 df022d00a9c4
parent 0 b3d96ac70a99
child 60 1d11a4e5ffd8
--- a/docs/README.txt	Fri Jan 18 15:32:56 2019 +0100
+++ b/docs/README.txt	Wed Nov 27 15:57:21 2019 +0100
@@ -0,0 +1,31 @@
+=====================
+PyAMS_viewlet package
+=====================
+
+.. contents::
+
+
+What is PyAMS
+=============
+
+PyAMS (Pyramid Application Management Suite) is a small suite of packages written for applications
+and content management with the Pyramid framework.
+
+**PyAMS** is actually mainly used to manage web sites through content management applications (CMS,
+see PyAMS_content package), but many features are generic and can be used inside any kind of web
+application.
+
+
+What is PyAMS_viewlet?
+======================
+
+PyAMS_viewlet is a package which defines components called "content providers"; these content
+providers are named adapters which can be used inside Chameleon templates.
+
+PyAMS_viewlet is an adaptation of zope.viewlet package to be used inside Pyramid.
+
+
+How to use pyams_viewlet?
+=========================
+
+A whole set of PyAMS documentation is available on `ReadTheDocs <https://pyams.readthedocs.io>`_