diff --git a/README.txt b/README.txt index f014ec2..d0742d6 100644 --- a/README.txt +++ b/README.txt @@ -1,4 +1,49 @@ Introduction ============ +plone.app.discussion aims to be the new commenting system for Plone 4. It is developed as part of the Google Summer of Code 2009 by Timo Stollenwerk (student) and Martin Aspeli (mentor). + +For details on the progress of this project, visit our `Pivotal Tracker`. + +.. _`Pivotal Tracker`: http://www.pivotaltracker.com/projects/15135 + +Feel free to send bug reports to timo@zmag.de. + +Disclaimer +========== + +This is an alpha release! Alpha releases should only be used for testing and development. + +Buildout Installation +===================== + +To install plone.app.discussion, add the following code to your buildout.cfg:: + + [buildout] + ... + extends = + ... + http://good-py.appspot.com/release/plone.app.discussion/1.0a1 + + ... + + [instance] + ... + eggs = + ... + plone.app.discussion + + ... + + zcml = + ... + discussion.examplecontent + + ... + +Known Issues +============ + +- Clear and rebuild the catalog looses all the comments. + diff --git a/plone/app/discussion/README.txt b/plone/app/discussion/README.txt deleted file mode 100644 index 5b61714..0000000 --- a/plone/app/discussion/README.txt +++ /dev/null @@ -1,48 +0,0 @@ -============ -Introduction -============ - -plone.app.discussion aims to be the new commenting system for Plone 4. It is developed as part of the Google Summer of Code 2009 by Timo Stollenwerk (student) and Martin Aspeli (mentor). - -For details on the progress of this project, visit our `Pivotal Tracker`. - -.. _`Pivotal Tracker`: http://www.pivotaltracker.com/projects/15135 - -Feel free to send bug reports to timo@zmag.de. - -Disclaimer -========== - -This is an alpha release! Alpha releases should only be used for testing and development. - -Buildout Installation -===================== - -To install plone.app.discussion, add the following code to your buildout.cfg:: - - [buildout] - ... - extends = - ... - http://good-py.appspot.com/release/plone.app.discussion/1.0a1 - - ... - - [instance] - ... - eggs = - ... - plone.app.discussion - - ... - - zcml = - ... - discussion.examplecontent - - ... - -Known Issues -============ - -- Clear and rebuild the catalog looses all the comments. \ No newline at end of file