simple readme

Dawars · Jul 2, 2016 · 4fe17fe · 4fe17fe
1 parent 4f4c982
commit 4fe17fe
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+Pillow-SIMD
+===========
+
+Pillow-SIMD is "following" Pillow fork (which is PIL fork itself).
+
+For more information about original Pillow, please
+[read the documentation](http://pillow.readthedocs.io/),
+[check the changelog](https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst) and
+[find out how to contribute](https://github.com/python-pillow/Pillow/blob/master/.github/CONTRIBUTING.md).
+
+
+Contributing to Pillow-SIMD
+---------------------------
+
+**Important.** Pillow-SIMD and Pillow are two separate projects.
+Please submit bugs and improvements not related to SIMD to 
+[original Pillow](https://github.com/python-pillow/Pillow/issues/new).
+All bugs and fixes in Pillow will appear in next Pillow-SIMD version automatically.
diff --git a/README.rst b/README.rst
diff --git a/setup.py b/setup.py
@@ -720,7 +720,7 @@ def debug_build():
 setup(name=NAME,
       version=PILLOW_VERSION,
       description='Python Imaging Library (Fork)',
-      long_description=_read('README.rst').decode('utf-8'),
+      long_description=_read('README.md').decode('utf-8'),
       author='Alex Clark (Fork Author)',
       author_email='aclark@aclark.net',
       url='http://python-pillow.org',