Dockery/Pinry
1
0
Fork 0
mirror of https://github.com/pinry/pinry.git synced 2025-11-17 10:20:39 +01:00
Code Issues Packages Projects Releases Activity

Improved the documentation, bumped the version to 1.3.2, fixed the license in setup.py

Browse Source
This commit is contained in:
Isaac Bythewood
2013-09-26 02:31:38 +00:00
parent f835018bb6
commit c510be3de4
7 changed files with 129 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/getting_started.rst
View File

@@ -1,20 +1,26 @@
Getting Started
===============
Below are the most basic requirements and a small test to make sure everything
is running properly before you get into the heavy lifting. Alternatively you can
skip to deployment and use our Dockerfile that will build and run everything for
you!
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
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`)
* pip
* Pillow build dependencies or the most recent version installed on your OS and
use ``virtualenv --system-site-packages`` when initiating virtualenv.
After you have all of the above you can skip to Testing and make sure it all
works.