diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md deleted file mode 100644 index d8de43a..0000000 --- a/CONTRIBUTORS.md +++ /dev/null @@ -1,6 +0,0 @@ -# Contributors - -The core contributors for Pinry have been/currently are: - - * Isaac Bythewood - * Krzysztof Klimonda diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst new file mode 100644 index 0000000..882bb3a --- /dev/null +++ b/CONTRIBUTORS.rst @@ -0,0 +1,8 @@ +Contributors +============ + +The core contributors for Pinry have been/currently are: + +* Isaac Bythewood +* Krzysztof Klimonda + diff --git a/LICENSE.md b/LICENSE.rst similarity index 91% rename from LICENSE.md rename to LICENSE.rst index 8b1e33f..f090ecc 100644 --- a/LICENSE.md +++ b/LICENSE.rst @@ -1,7 +1,8 @@ -# License (Simplified BSD) +License (Simplified BSD) +======================== -Copyright (c) Pinry Contributors -All rights reserved. +| Copyright (c) Pinry Contributors +| All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: @@ -23,3 +24,4 @@ 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. + diff --git a/README.md b/README.md deleted file mode 100644 index 0fa0b45..0000000 --- a/README.md +++ /dev/null @@ -1,59 +0,0 @@ -# ![Pinry](https://raw.github.com/pinry/pinry/master/logo.png) - -The open-source core of Pinry, a tiling image board system for people who -want to save, tag, and share images, videos and webpages in an easy to skim -through format. - -For more information and a working demo board visit -[getpinry.com](http://getpinry.com/). - -For the latest documentation check out -[Read the Docs](http://pinry.readthedocs.org/). - - -## Requirements - -Pinry is built on top of Django and optimized to run on a Linux environment. -However we have gotten Pinry to work on Windows and Mac as well but it may -require some extra digging around configuration. Pinry's Python requirements are -all in the `requirements.txt` file and easily installable once you have up a -virtual environment. What you need initially: - - * Python - * pip - * virtualenv - * Your OS's build tools (Ubuntu: `build-essential`, Mac: `Xcode`) - * Build dependencies for PIL/Pillow (Ubuntu: `apt-get build-dep python-imaging`) - -After you have all of the above you can skip to Testing and make sure it all -works. - - -## Testing - -We have many tests built into Pinry to ensure that changes don't break anything. -If you are live dangerously and have cutting edge new Pinry features first you -can use our master branch for your own instance. We recommend using our -tags/versions though. - -To run Pinry's tests inside the Pinry repo run: - - virtualenv . - bin/pip install -r requirements.txt - bin/python manage.py test - - -## Production Deployment - -Our supported and suggested way to deploy Pinry is using Docker. We provide -support and instructions for that over at the -[docker-pinry GitHub repository](https://github.com/pinry/docker-pinry). - -If you'd like a different setup then check out the hundreds of tutorials -for production Django deployment found via Google. - - -## Current Master Build Status - -[ ![Codeship Status for pinry/pinry](https://www.codeship.io/projects/461ebc50-70be-0130-073a-22000a9d07d8/status?branch=master)](https://www.codeship.io/projects/2005) - diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..81d4689 --- /dev/null +++ b/README.rst @@ -0,0 +1,70 @@ +|Pinry| +======= + +The open-source core of Pinry, a tiling image board system for people +who want to save, tag, and share images, videos and webpages in an easy +to skim through format. + +For more information and a working demo board visit `getpinry.com`_. For the +latest documentation check out `Read the Docs`_. + + +Requirements +------------ + +Pinry is built on top of Django and optimized to run on a Linux +environment. However we have gotten Pinry to work on Windows and Mac as +well but it may require some extra digging around configuration. Pinry's +Python requirements are all in the ``requirements.txt`` file and easily +installable once you have up a virtual environment. What you need +initially: + +* Python +* pip +* virtualenv +* Your OS's build tools (Ubuntu: ``build-essential``, Mac: ``Xcode``) +* Build dependencies for PIL/Pillow (Ubuntu: + ``apt-get build-dep python-imaging``) + + +Testing +------- + +We have many tests built into Pinry to ensure that changes don't break +anything. If you are live dangerously and have cutting edge new Pinry +features first you can use our master branch for your own instance. We +recommend using our tags/versions though. + +To run Pinry's tests inside the Pinry repo run:: + + virtualenv . + bin/pip install -r requirements.txt + bin/python manage.py test + + +Production Deployment +--------------------- + +Our supported and suggested way to deploy Pinry is using Docker. We +provide support and instructions for that over at the `docker-pinry +GitHub repository`_. + +If you'd like a different setup then check out the hundreds of tutorials +for production Django deployment found via Google. + + +Current Master Build Status +--------------------------- + +|Codeship Status for pinry/pinry| + + +.. Links + +.. |Pinry| image:: https://raw.github.com/pinry/pinry/master/logo.png +.. |Codeship Status for pinry/pinry| image:: https://www.codeship.io/projects/461ebc50-70be-0130-073a-22000a9d07d8/status?branch=master + :target: https://www.codeship.io/projects/2005 +.. _getpinry.com: http://getpinry.com/ +.. _Read the Docs: http://pinry.readthedocs.org/ +.. _docker-pinry GitHub repository: https://github.com/pinry/docker-pinry + diff --git a/setup.py b/setup.py index 91e1d5a..7a36497 100644 --- a/setup.py +++ b/setup.py @@ -29,7 +29,7 @@ setup( keywords="django tiling board tag share images pictures videos webpages", url="http://getpinry.com/", packages=find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]), - long_description=read('README.md'), + long_description=read('README.rst'), dependency_links=dependency_links, tests_require=['mock', 'factory-boy>=1.3,<2.0'], install_requires=install_requires,