add cesar

[libreriscv.git] / HDL_workflow / git_intro.mdwn

diff --git a/HDL_workflow/git_intro.mdwn b/HDL_workflow/git_intro.mdwn
index b14bd1ea584eb2a079c56d93c14a6993ee41e3f9..a867964d012b307cf3cb1ac952d127e8fdfeeef9 100644 (file)
--- a/HDL_workflow/git_intro.mdwn
+++ b/HDL_workflow/git_intro.mdwn
@@ -10,11 +10,14 @@
 In git you do this by:
 
 * *Cloning* a repository (aka downloading stuff)
-* *Committing* your local changes (aka you "take note" of what you did. e.g. modified some files, added new files, deleted some files and so on)
-* *Pushing* your work online (aka uploading online)
+* *Committing* your local changes (aka you "take note" of what you
+  did. e.g. modified some files, added new files, deleted some files and
+  so on)
+* *Pushing* your work online
 
 ## Cloning
-(optional) `cd ` + somewhere in your disk  
+
+(optional) [[!template id=popup mouseover="`cd <somewhere in your disk>` (?)" popup="""'cd' stands for 'change directory'. <br>It let you change the working directory to another one.""" ]]  
 `git clone ` + repo url
 
 ## Making changes
@@ -23,7 +26,10 @@ In git you do this by:
 ## Committing
 `git add` + files you want to "take note" of.
 
-E.g. `git add test.png` will take note of the “test.png" file for when you will want to commit your work. (Committing your work is like saving in a videogame. When you are good with what you have done, you save the stage of the adventure).
+E.g. `git add test.png` will take note of the “test.png" file for when
+you will want to commit your work. (Committing your work is like saving
+in a videogame. When you are good with what you have done, you save the
+stage of the adventure).
 
 When committing you are required to add a comment to your "save file" (commit).  
 Like ~~"I added the test.png file"~~.  
@@ -33,7 +39,8 @@ Ahah, I was kidding. Remember:
 > not what ACTION was done on what file.
 
 ## Pushing
-When you are done committing all your stuff, you want to share it with other. So you push on the remote repository (directory).
+When you are done committing all your stuff, you want to share it with
+other. So you push to the remote repository (directory).
 
 So you just `git push`.
 
@@ -43,21 +50,24 @@ Pay attention to:
 
 * what you modify in the repository 
 * what files you add to your commit
-* when pushing, what are you actually pushing
+* before pushing, what you are actually going to push
 
 ### Notes 2
-When doing `git commit` best thing to do is to add ` -m "<comment here, without brackets>"`
+When doing `git commit` the quickest way to add the comment is by adding
+` -m "<your comment here, without brackets>"`
 
-Like this: `git commit -m "added test.png"`.
+Like this: `git commit -m "made a correction to the calculate_sum function"`.
 
-If you omit the -m option, a text editor will appear to let you insert a commit message. Sometimes is useful to let git open the editor. e.g. for long comments or comments with quotes in it.
+If you omit the -m option, a text editor will appear to let you
+insert a commit message. Sometimes it is useful to let git open the
+editor. e.g. for long comments or comments with quotes in it.
 
-If `vim` editor opens (you get stuck into something you do not know how to exit from), remember:
+If `vim` editor opens (you get stuck into something you do not know how
+to exit from), remember:
 
 * type `i` to "insert text".
-* when you are doing typing some text, press the esc key on the keyboard
+* when you are done typing text, press the esc key on the keyboard
 * if you want to save the comment/text, press `w` (means "write")
 * to quit, press `q`
-
-You are done.  
-To quit without saving/writing: `q!` (e.g. you want to exit)
+  
+To quit without saving/writing type: `q!` (e.g. you want to exit)