Updating base docs

This commit is contained in:
Isaac Bythewood
2013-09-25 02:48:52 +00:00
parent 14ce634afa
commit edd0efb6ce
4 changed files with 47 additions and 18 deletions

View File

@@ -7,6 +7,9 @@ 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

View File

@@ -1,5 +1,10 @@
Deployment
==========
Coming soon...
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.

View File

@@ -1,5 +1,36 @@
Getting Started
===============
Coming soon...
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

View File

@@ -9,12 +9,12 @@ format.
Useful Links
------------
* `Get Pinry`_: http://getpinry.com/
* `About Pinry`_: http://getpinry.com/about/
* `Pinry Demo`_: http://demo.getpinry.com/
* `pinry/pinry`_: https://github.com/pinry/pinry
* `pinry/docker-pinry`_: https://github.com/pinry/docker-pinry
* `pinry/getpinry.com`_: https://github.com/pinry/getpinry.com
* Get Pinry: http://getpinry.com/
* About Pinry: http://getpinry.com/about/
* Pinry Demo: http://demo.getpinry.com/
* pinry/pinry: https://github.com/pinry/pinry
* pinry/docker-pinry: https://github.com/pinry/docker-pinry
* pinry/getpinry.com: https://github.com/pinry/getpinry.com
@@ -27,13 +27,3 @@ Documentation
getting_started
deployment
.. Links
.. _`Get Pinry`: http://getpinry.com/
.. _`About Pinry`: http://getpinry.com/about/
.. _`Pinry Demo`: http://demo.getpinry.com/
.. _`pinry/pinry`: https://github.com/pinry/pinry
.. _`pinry/docker-pinry`: https://github.com/pinry/docker-pinry
.. _`pinry/getpinry.com`: https://github.com/pinry/getpinry.com