From 354c8747beeabfec7b2ff33de8566cb4db213ec7 Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Mon, 9 Jun 2014 12:22:13 +0200 Subject: add note to requirements to readme --- README.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.rst b/README.rst index 2b6003f..afe5272 100644 --- a/README.rst +++ b/README.rst @@ -46,6 +46,17 @@ If the dependencies are in place, simply issue ``omake`` in the repository directory and the executable ``context_mirror_bot`` is created. +Prerequisites +************* + +The *Context Mirror Bot* assumes an ``unzip(1)`` executable accessible +from the ``$PATH``. The same goes for standard userland utilities like +``cp(1)`` and ``rm(1)``. In dubious cases, the `GNU Coreutils`_ are +assumed the canonical implementation. + +It goes without saying that ``git(1)`` must be installed on the system +as well. + Run *** @@ -57,6 +68,7 @@ Currently this presents you with this list of options: --check check source timestamps --status print status of local repo +--sync sync local repo and remotes --update update from sources --prepare prepare local repository --download download source packages @@ -121,4 +133,5 @@ under the name ``COPYING``. .. _Omake: http://omake.metaprl.org/index.html .. _Philipp Gesang: mailto:philipp.gesang@alumni.uni-heidelberg.de .. _original script: https://gitorious.org/context/context/source/d493b9c93ad826044bd17889da2ee099c8ed72d5:context_git_update.pl +.. _GNU Coreutils: http://www.gnu.org/s/coreutils/ -- cgit v1.2.3