com web/rmtools: further readme notes: README.md

Commit: c30ba01fcfb5ad8a83d47f91f04a25611b13410d Author: Anatol Belski <ab@php.net> Mon, 28 Nov 2016 17:07:24 +0100 Parents: 14f7a3aa35c0ed8baacfe400e3f5ab01cd5fed17 Branches: master Link: http://git.php.net/?p=web/rmtools.git;a=commitdiff;h=c30ba01fcfb5ad8a83d47f91f04a25611b13410d Log: further readme notes Changed paths: M README.md Diff: diff --git a/README.md b/README.md index 8916baa..56e11f3 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,16 @@ The PHP RMTOOLS itself is licensed under the BSD 2-Clause license. With the usag # Requirements +- Visual Studio - [PHP-SDK](https://github.com/OSTC/php-sdk-binary-tools) # Usage -NOTE: All the paths in the usage exampled are on drive C: for simplicity. Locations of PHP SDK and RMTOOLS are customizable and are not bound to a firm path on the system. +NOTE: All the paths in the usage exampled are on drive C: for simplicity. Locations of PHP SDK and RMTOOLS are customizable and are not bound to a firm path on the system. All the path configuration is editable in the corresponding branch ini files under rmtools\data\config\branch + + +## Preparing - install [Git](https://git-scm.com/) @@ -29,4 +33,17 @@ NOTE: All the paths in the usage exampled are on drive C: for simplicity. Locati - 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\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 + +- 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" + +To make a x86 build, the corresponding starter script from the PHP SDK needs to be used. +