Browse Source

Update 'project/functions/README.md'

Denis Gilles 7 years ago
parent
commit
9bd28cc29f
1 changed files with 5 additions and 31 deletions
  1. 5 31
      project/functions/README.md

+ 5 - 31
project/functions/README.md

@@ -2,47 +2,21 @@
 
 In this chapter we will create the functions to say Hello in the different languages from the table above.
 
-In the beginning you will add a new file in the Git_Training project similar to `greetings.sh` with your function e.g. `greetings_catalan.sh`.
+In the beginning you will modify the file `greetings.sh` by adding your function e.g. `say_hello_catalan.sh`.
 
-Then you will modify `run.sh` to source and call your function.
+Then you will modify `run.sh` to call your function.
 
-In a further chapter of this tutorial, we will merge all functions in the same file `greetings.sh` and we will see how git helps on the process of resolving conflicts.
-
-Try to have well documented functions in bash.
-
-An example of a header of a Bash function is provided below:
-
-```
-  # Functions to deal with greetings
-  #
-  # Written by My_name
-  #
-  # Earth and Life Institute / Université catholique de Louvain (ELIC-UCL)
-  # Created: May 4, 2017
-  # Adapted:
- 
-  #######################################
-  # Say Hello in English
-  # Globals:
-  # Arguments: 
-  # None
-  # Returns:
-  # None
-  #######################################
-  function say_hello() {
-    echo "Hello world !"
-  }
-```
+In a further chapter of this tutorial, we will merge all the calls in the same file `run.sh` and we will see how git helps on the process of resolving conflicts.
 
 #### Exercise 6 – Perform function commit
 
-Now you have time to make changes in Git_Training project, i.e. create 'greetings_catalan.sh' file and develop your function. After that, if we check the status of our project again, Git tells us that it’s noticed a new file. We can tell Git to track a file using git add.
+Now you have time to make changes in Git_Training project, i.e. modify 'greetings.sh' file and develop your function. After that, if we check the status of our project again, Git tells us that it’s noticed a new file. We can tell Git to track a file using git add.
 
 ```
 git add .
 ```
 
-Git now knows that it’s supposed to keep track of 'greetings_catalan.sh', but it hasn’t recorded these changes as a commit yet. To get it to do that, we need to run one more command:
+Git now knows that it’s supposed to keep track of 'greetings.sh', but it hasn’t recorded these changes as a commit yet. To get it to do that, we need to run one more command:
 
 ```
 git commit -m "message explaining what you have done. Fixes issue #issue_number"