Horst Gutmann avatar Horst Gutmann committed 22f1c9f

Updates readme and adds license file

Comments (0)

Files changed (4)

+Copyright (c) 2009-2012, Harro van der Klauw, Horst Gutmann
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
+POSSIBILITY OF SUCH DAMAGE.
+include README.rst
+include LICENSE.txt

README.md

-This plugin provides a simple news feature for django-cms 2.0 and newer.
-
-## Setup
-
-* Install django-cms (if you haven't done so already)
-* Run `pip install cmsplugin-news` or download this package and run `python setup.py install` or add it in some other way to your current PYTHON_PATH
-* Add 'cmsplugin_news' to INSTALLED_APPS
-* If you're using South execute `python manage.py migrate`, Otherwise run `python manage.py syncdb` within your project directory.
-* In order to integrate the news-plugin with your website, create a page and add the news application (and optionally the news menu) to it by modifying the relevant "advanced settings" of it.
-
-## Last tested with
-
-* django-cms-2.2
-* django: 1.3.1
-
-## History
-
-### 0.4 (unreleased)
-
-* RSS/Atom feed
-* CMS menu integration
-* Upgrade to django-cms 2.2
-* ...
-
-### 0.3
-
-* Moved to beta phase
-* Tested with django-cms 2.0 final
-
-### 0.2b
-
-* Various bug fixes
-
-### 0.2a/0.1a5
-
-* Adds excerpt to news model
+News plugin for django-cms 2.x
+===============================
+
+This plugin provides a simple news feature for django-cms 2.0 and newer and
+and tries to keep it as simple as possible without extras like tagging or
+categories but while providing a news feed and menu integration.
+
+Setup
+-----
+
+* Install django-cms (if you haven't done so already)
+
+* Run `pip install cmsplugin-news` or download this package and run
+  `python setup.py install` or add it in some other way to your current
+  PYTHON_PATH
+
+* Add 'cmsplugin_news' to INSTALLED_APPS
+
+* If you're using South execute `python manage.py migrate`, Otherwise run
+  `python manage.py syncdb` within your project directory.
+* In order to integrate the news-plugin with your website, create a page and add
+  the news application (and optionally the news menu) to it by modifying the
+  relevant "advanced settings" of it.
+
+Last tested with
+----------------
+
+* django-cms-2.2
+* django: 1.3.1
+
+History
+-------
+
+0.4 (unreleased):
+    * Probably a new maintainer
+    * RSS/Atom feed
+    * CMS menu integration
+    * Upgrade to django-cms 2.2
+    * ...
+
+0.3:
+    * Moved to beta phase
+    * Tested with django-cms 2.0 final
+
+0.2b:
+    * Various bug fixes
+
+0.2a/0.1a5:
+    * Adds excerpt to news model
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.