Commit52b7b10

committed

"added readmes to the tests and bin folder"

1 parent689df58 commit52b7b10Copy full SHA for 52b7b10

File tree

+34

-0

lines changed

+34

-0

lines changed

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,9 @@`
	`1`	`+#Folderbin/`
	`2`	`+`
	`3`	`+* Folder with additional scripts or executables to help with the development of the project.`
	`4`	`+`
	`5`	`+##Files`
	`6`	`+`
	`7`	`+###Thebin/FUNCTION_HELPERS.sh`
	`8`	`+`
	`9`	`+* Secondary (helper) script that is called by the main "../SETUP_TEMPLATE.sh" file to call some functions and obtain some exported variables to better modularize the code.`

Lines changed: 25 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,25 @@`
	`1`	`+#Foldertests/`
	`2`	`+`
	`3`	`+* Folder with all the tests used to test the "../SETUP_TEMPLATE.sh" script.`
	`4`	`+`
	`5`	`+##Files`
	`6`	`+`
	`7`	`+###Thetests/shunit2`
	`8`	`+`
	`9`	`+* Framework used for the unit tests more info can be found in the[shunit2's GitHub repository](https://github.com/kward/shunit2).`
	`10`	`+`
	`11`	`+###Thetests/argument_help_parser.sh`
	`12`	`+`
	`13`	`+* Test suite for testing the help flag (--help).`
	`14`	`+`
	`15`	`+###Thetests/custom_data_test.sh`
	`16`	`+`
	`17`	`+* Test suite for testing the modified custom data, after executing the SETUP_TEMPLATE script.`
	`18`	`+`
	`19`	`+###Thetests/project_scaffolding_test.sh`
	`20`	`+`
	`21`	`+* Test suite for testing the project scaffolding after executing the SETUP_TEMPLATE script.`
	`22`	`+`
	`23`	`+###Thetests/TESTS_RUNNER.sh`
	`24`	`+`
	`25`	`+* Main test script that will call all the individual unitary tests. Exit code 1 means an error in one or more tests was found, otherwise, the exit code will be 0.`

Comments

(0)