From bbf8217b90af4a17d3c4f4adddcc8297a3e22f51 Mon Sep 17 00:00:00 2001 From: Arne Schauf Date: Sat, 28 Sep 2013 10:24:05 +0200 Subject: [PATCH] installation howto and basic requirements --- README.md | 21 +++++++++++++++++++++ requirements.d/all.txt | 2 ++ requirements.d/dev.txt | 1 + 3 files changed, 24 insertions(+) create mode 100644 requirements.d/all.txt create mode 100644 requirements.d/dev.txt diff --git a/README.md b/README.md index d755db2..acdcf25 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,24 @@ www.nsupdate.info is a free dynamic dns service. nsupdate.info is also the name of the software used to implement it. + +Installation +=================== + +If you haven't already done create and change to a virtualenv for the installation (here with virtualenvwrapper) +``` +mkvirtualenv nsupdate +workon nsupdate +``` +Clone the repo and cd into +``` +git clone git@github.com:asmaps/nsupdate.info.git +cd nsupdate.info +``` +Then install requirements (either "dev" or just "all" for production) +``` +pip install -r requirements.d/all.txt +#or for dev +pip install -r requirements.d/dev.txt +``` +From time to time execute this again to install the newest dependencies. diff --git a/requirements.d/all.txt b/requirements.d/all.txt new file mode 100644 index 0000000..561cd39 --- /dev/null +++ b/requirements.d/all.txt @@ -0,0 +1,2 @@ +django==1.5.4 +south diff --git a/requirements.d/dev.txt b/requirements.d/dev.txt new file mode 100644 index 0000000..aec394f --- /dev/null +++ b/requirements.d/dev.txt @@ -0,0 +1 @@ +django-debug-toolbar