From df4d18c7be7fe9799b982e9eec0651f8a6a06092 Mon Sep 17 00:00:00 2001 From: winkidney Date: Mon, 24 Dec 2018 15:01:10 +0800 Subject: [PATCH] Doc: Add doc for users to setup / add more description for development --- README.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.rst b/README.rst index 92d542e..ea9bb37 100644 --- a/README.rst +++ b/README.rst @@ -16,6 +16,25 @@ Feature - multi-user support - Both public and private is supported + +Setup Guide for users +-------------------------- + +Please use docker to install `docker-pinry `_ + +Developers or users which is familiar with python/nginx could setup Pinry following following guide : ) + +Quick Start for Developers +---------------------------- + +You need only three following lines to initialize your pinry:: + + make install + make serve + +Now the development server has been running, enjoy : ) + + Upgrade from old version -------------------------- @@ -85,6 +104,9 @@ changing settings file in `pinry/settings`. docker-compose exec web python3 manage.py migrate --settings=pinry.settings.docker +**Note** : No static file server configured, your should configure nginx or other server to serve +static files from ./static + Linting -------