com web/rmtools: Improve usage description: README.md

Commit: 1c5b9f4f7e040c6cce520ca7b424c98cc854c7e4 Author: Christoph M. Becker <cmbecker69@gmx.de> Fri, 22 Mar 2019 09:43:47 +0100 Parents: fb2bd63db2eb9b9dffc9dde024b374f93e4978e8 Branches: master Link: http://git.php.net/?p=web/rmtools.git;a=commitdiff;h=1c5b9f4f7e040c6cce520ca7b424c98cc854c7e4 Log: Improve usage description Besides fixing some of the commands and paths, we also specify the meaning of the --task-args. Changed paths: M README.md Diff: diff --git a/README.md b/README.md index d74d1d9..49cfd37 100644 --- a/README.md +++ b/README.md @@ -27,22 +27,27 @@ NOTE: All the paths in the usage exampled are on drive C: for simplicity. Locati - install [Git](https://git-scm.com/), alternatively - fetch the latest tags for RMTOOLS and PHP SDK - md c:\php-snap-build - cd c:\php-snap-build -- git clone https://github.com/OSTC/php-sdk-binary-tools.git --branch new_binary_tools php-sdk -- git clone https://github.com/php/web-rmtools.git --branch new_sdk_compliance rmtools +- git clone https://github.com/Microsoft/php-sdk-binary-tools.git php-sdk +- git clone https://github.com/php/web-rmtools.git rmtools - md c:\php-snap-build\obj-x64, or alternatively similar to mklink /d obj-x64 d:\tmp-obj-x64 - md c:\php-snap-build\obj, or alternatively similar to mklink /d obj d:\tmp-obj - md C:\php-snap-build\snap_master\vc14\x64 - md C:\php-snap-build\snap_master\vc14\x86 +- copy C:\php-snap-build\rmtools\bin\rmtools_setvars.bat-dist to C:\php-snap-build\rmtools\bin\rmtools_setvars.bat, set the appropriate values - copy C:\php-snap-build\rmtools\data\config\credentials_ftps.php-dist to C:\php-snap-build\rmtools\data\config\credentials_ftps.php, set the appropriate values ## Buiding -With this configuration, for example for a 64-bit build +With this configuration, for example for a VC14 64-bit build - the build dir is C:\php-snap-build\snap_master\vc14\x64 - the object dir is C:\php-snap-build\obj-x64 - the package dir is C:\php-snap-build\obj-x64 -- run c:\php-snap-build\php-sdk\phpsdk-vc14-x64.bat -t c:\php-snap\build\bin\snapshot_task.bat --task-args "phpmaster all" +- run c:\php-snap-build\php-sdk\phpsdk-vc14-x64.bat -t c:\php-snap-build\rmtools\bin\snapshot_task.bat --task-args "<branch> <type>" + +<branch> is the name of one of the INI files in data\config\branch (e.g. phpmaster), +and <type> is the name of one of the sections in that INI file (e.g. nts-windows-vc15-x64). +<type> can also be all, to build all types defined in the given INI file. To make a x86 build, the corresponding starter script from the PHP SDK needs to be used.