From 41ad908bc614a30aea2508b437f606976f472743 Mon Sep 17 00:00:00 2001 From: Christopher Vagnetoft Date: Tue, 10 Jan 2017 15:45:56 +0100 Subject: [PATCH] Updated readme with more info on props --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 728e1d9..38db411 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,18 @@ To evaluate props when building the archive: props exec="generate-props.php"; +The props are defined, and the keys are cast to upper case. Be careful if you +attempt to redefine any of these values from within your project as this will +fail. What you should do is something like: + + if (!defined('MYAPP_VERSION')) define('MYAPP_VERSION','dev'); + echo "This is MyApp ".MYAPP_VERSION."\n"; + +This makes sure that you don't try to set an existing define, and also that the +defines generated from props by MakePhar is also available when running the app +from source. + + ## Options and Tweaks Boolean options (such as `verbatim` and `library`) will have their value default