From 670222bc31e7b5453b0b797c68ae98e55122bf2a Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Sat, 12 Apr 2014 20:15:34 +0200 Subject: [PATCH 1/4] Add section about Dependency Installation to README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index de528231..7d8a635d 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,20 @@ AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509 PEAR Channel PEAR Channel: [phpseclib.sourceforge.net](http://phpseclib.sourceforge.net/pear.htm) + +## Installing Dependencies + +Dependencies are managed via Composer. + +1. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable as per the + [Composer Download Instructions](https://getcomposer.org/download/), e.g. by running + + ``` sh + curl -sS https://getcomposer.org/installer | php + ``` + +2. Install Dependencies + + ``` sh + php composer.phar install --dev + ``` From a7e7f5891ab599501f3688d7b1aee46f8d3e0686 Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Sat, 12 Apr 2014 20:26:27 +0200 Subject: [PATCH 2/4] Add Contributing section to README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 7d8a635d..c33f8742 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,25 @@ Dependencies are managed via Composer. ``` sh php composer.phar install --dev ``` + +## Contributing + +1. Fork the project + +2. Install Dependencies + +3. Create a feature branch + +4. (Optional) Run the Test Suite + + ``` sh + vendor/bin/phpunit + ``` + +5. (Optional) Check whether your code conforms to our coding standards by running + + ``` sh + vendor/bin/phing -f build/build.xml sniff + ``` + +6. Send us a pull request From 9653e3c70fa7052c927d1aa4e7b95a2f335fc998 Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Sat, 12 Apr 2014 20:35:30 +0200 Subject: [PATCH 3/4] Capitalisation improvements. --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c33f8742..6399aeee 100644 --- a/README.md +++ b/README.md @@ -34,22 +34,21 @@ Dependencies are managed via Composer. ## Contributing -1. Fork the project +1. Fork the Project 2. Install Dependencies -3. Create a feature branch +3. Create a Feature Branch -4. (Optional) Run the Test Suite +4. (Recommended) Run the Test Suite ``` sh vendor/bin/phpunit ``` - -5. (Optional) Check whether your code conforms to our coding standards by running +5. (Recommended) Check whether your code conforms to our Coding Standards by running ``` sh vendor/bin/phing -f build/build.xml sniff ``` -6. Send us a pull request +6. Send us a Pull Request From 4fece986e3827f13ff11edb2bb90b605aa37fc39 Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Tue, 15 Apr 2014 16:51:50 +0200 Subject: [PATCH 4/4] Use "Development Dependencies" instead of "Dependencies" for less confusion. There are currently no production dependencies. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6399aeee..3edd16aa 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ AES, Blowfish, Twofish, SSH-1, SSH-2, SFTP, and X.509 PEAR Channel PEAR Channel: [phpseclib.sourceforge.net](http://phpseclib.sourceforge.net/pear.htm) -## Installing Dependencies +## Installing Development Dependencies Dependencies are managed via Composer. @@ -36,7 +36,7 @@ Dependencies are managed via Composer. 1. Fork the Project -2. Install Dependencies +2. Install Development Dependencies 3. Create a Feature Branch