Browse Source

Update README with Testing and Requirements sections

tags/v1.0.0
Isaac Bythewood 11 years ago
parent
commit
20359b886d
1 changed files with 43 additions and 3 deletions
  1. +43
    -3
      README.md

+ 43
- 3
README.md View File

@@ -1,8 +1,48 @@
# ![Pinry](https://bitbucket.org/pinry/pinry/raw/master/logo.png) # ![Pinry](https://bitbucket.org/pinry/pinry/raw/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.
This is 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 including docs, a tour, and even hosted instances please
visit [getpinry.com](http://getpinry.com/)


## 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

Current build status on our CI server:
![Codeship Status for pinry/pinry](https://www.codeship.io/projects/461ebc50-70be-0130-073a-22000a9d07d8/status?branch=master)



For more information including docs, a tour, and even hosted instances please For more information including docs, a tour, and even hosted instances please
visit [getpinry.com](http://getpinry.com/) visit [getpinry.com](http://getpinry.com/)


Loading…
Cancel
Save