Documentation

Author: steevanb

codeValidation.sh

@@ -47,4 +47,4 @@ echoValidationGroupEnd
 
 source "$RESULT_TYPE_PATH/codeValidation.sh"
 
-echoValidationOk "Code is valid. If everything is done and commited, you can use \"./codeLink.sh $COMPONENT_TYPE $RESULT_TYPE_SLUG $INSTALLATION_PATH\"."
+echoValidationOk "Code is valid. If everything is done and commited, you can use \"./codeLink.sh $COMPONENT_TYPE $RESULT_TYPE_SLUG\"."

documentation/codeLink.md

@@ -20,10 +20,9 @@ To do it easily, you can use `./codeLink.sh`.
 ./codeLink.sh
 -
 
-Without any parameter, it will ask you 3 informations:
+Without any parameter, it will ask you 2 informations:
 * component type (framework or templateEngine)
 * benchmark type (hello-world or rest-api)
-* path to your code
 
 ```bash
 cd vendor/phpbenchmarks/benchmark-kit
@@ -32,10 +31,8 @@ cd vendor/phpbenchmarks/benchmark-kit
 ./codeLink.sh
 # first parameter is component type, it will ask only the 2 next informations
 ./codeLink.sh framework
-# second parameter is benchmark type, it will ask only the path to your code
-./codeLink.sh framework hello-world
 # all informations are passed as parameters, no ask
-./codeLink.sh framework hello-world /foo/bar
+./codeLink.sh framework hello-world
 ```
 
 [Back to documentation index](../README.md)

documentation/codeValidation.md

@@ -13,10 +13,9 @@ What will be validated:
 ./codeValidation.sh
 -
 
-Without any parameter, it will ask you 3 informations:
+Without any parameter, it will ask you 2 informations:
 * component type (framework or templateEngine)
 * benchmark type (hello-world or rest-api)
-* path to your code
 
 Available options:
 * `-v`: view each validations performed
@@ -31,10 +30,8 @@ cd vendor/phpbenchmarks/benchmark-kit
 ./codeValidation.sh
 # first parameter is component type, it will ask only the 2 next informations
 ./codeValidation.sh framework
-# second parameter is benchmark type, it will ask only the path to your code
-./codeValidation.sh framework hello-world
 # all informations are passed as parameters, no ask
-./codeValidation.sh framework hello-world /foo/bar
+./codeValidation.sh framework hello-world
 ```
 
 [Back to documentation index](../README.md)

documentation/composerUpdate.md

@@ -13,10 +13,9 @@ To create them, you can use `./composerUpdate.sh`, who will do a `composer updat
 ./composerUpdate.sh
 -
 
-Without any parameter, it will ask you 3 informations:
+Without any parameter, it will ask you 2 informations:
 * component type (framework or templateEngine)
 * benchmark type (hello-world or rest-api)
-* path to your code
 
 Available options:
 * `-v`: view each validations performed
@@ -31,10 +30,8 @@ cd vendor/phpbenchmarks/benchmark-kit
 ./composerUpdate.sh
 # first parameter is component type, it will ask only the 2 next informations
 ./composerUpdate.sh framework
-# second parameter is benchmark type, it will ask only the path to your code
-./composerUpdate.sh framework hello-world
 # all informations are passed as parameters, no ask
-./composerUpdate.sh framework hello-world /foo/bar
+./composerUpdate.sh framework hello-world
 ```
 
 [Back to documentation index](../README.md)

documentation/initializeBranch.md

@@ -17,10 +17,9 @@ Feel free to edit them manually.
 ./initializeBranch.sh
 -
 
-Without any parameter, it will ask you 3 informations:
+Without any parameter, it will ask you 2 informations:
 * component type (framework or templateEngine)
 * benchmark type (hello-world or rest-api)
-* path to your code
 
 Available options:
 * `-v`: view each validations performed
@@ -33,10 +32,8 @@ cd vendor/phpbenchmarks/benchmark-kit
 ./initializeBranch.sh
 # first parameter is component type, it will ask only the 2 next informations
 ./initializeBranch.sh framework
-# second parameter is benchmark type, it will ask only the path to your code
-./initializeBranch.sh framework hello-world
 # all informations are passed as parameters, no ask
-./initializeBranch.sh framework hello-world /foo/bar
+./initializeBranch.sh framework hello-world
 ```
 
 [Back to documentation index](../README.md)