Rework documentation files

collective · Nov 24, 2015 · d3493e0 · d3493e0
1 parent 1f040f8
commit d3493e0
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 40 deletions.
diff --git a/docs/HISTORY.txt → CHANGES.rst b/docs/HISTORY.txt → CHANGES.rst
diff --git a/docs/CREDITS.txt → CONTRIBUTORS.rst b/docs/CREDITS.txt → CONTRIBUTORS.rst
diff --git a/README.rst b/README.rst
@@ -33,6 +33,24 @@ site in the future.
 This package helps you make your Plone site comply with these `technical
 requirements`_.
 
+Installation
+============
+
+To enable this product in a buildout-based installation:
+
+1. Edit your buildout.cfg and add ``collective.googlenews`` to the list of eggs to install::
+
+    [buildout]
+    ...
+    eggs =
+        collective.googlenews
+
+After updating the configuration you need to run ''bin/buildout'', which will take care of updating your system.
+
+Go to the 'Site Setup' page in a Plone site and click on the 'Add-ons' link.
+
+Check the box next to ``collective.googlenews`` and click the 'Activate' button.
+
 Article URLs
 ============
 

diff --git a/docs/INSTALL.txt b/docs/INSTALL.txt
diff --git a/setup.py b/setup.py
@@ -1,11 +1,13 @@
-from setuptools import setup, find_packages
-import os
+# -*- coding: utf-8 -*-
+from setuptools import find_packages
+from setuptools import setup
 
 version = '2.0a1.dev0'
-long_description = open("README.rst").read() + "\n" + \
-                   open(os.path.join("docs", "INSTALL.txt")).read() + "\n" + \
-                   open(os.path.join("docs", "CREDITS.txt")).read() + "\n" + \
-                   open(os.path.join("docs", "HISTORY.txt")).read()
+long_description = (
+    open('README.rst').read() + '\n' +
+    open('CONTRIBUTORS.rst').read() + '\n' +
+    open('CHANGES.rst').read()
+)
 
 setup(name='collective.googlenews',
       version=version,
@@ -20,7 +22,6 @@
         "Intended Audience :: System Administrators",
         "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
         "Operating System :: OS Independent",
-        "Programming Language :: JavaScript",
         "Programming Language :: Python",
         "Programming Language :: Python :: 2.7",
         "Topic :: Office/Business :: News/Diary",