aboutsummaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorRaul Infante-Sainz <infantesainz@gmail.com>2020-01-22 23:21:03 +0000
committerRaul Infante-Sainz <infantesainz@gmail.com>2020-01-22 23:21:03 +0000
commit195a3c51fd83775d0ad613783ef5a10b8992d150 (patch)
treeb3cd54e1565772594d6a4cf2bb97c6e2fe8319f4 /README-hacking.md
parent7ac86df891798fd1f0ef4d7a40aff43ec9621854 (diff)
Adding basic configuration of Git in README-hacking.md
Until this commit, we were asuming that Git was already properly configured. However, in order to be as complete as possible, it would be good if the basic commands to configure Git were in the `README-hacking.md'. With this commit, a small paragraph has been added in order to have the basic Git configuration commands (i.e. to configure the name, email, and favorite text editor).
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README-hacking.md b/README-hacking.md
index 83c341b..7116cda 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -444,7 +444,7 @@ project is designed to grow in this framework.
File modification dates (meta data)
-----------------------------------
-While git does an excellent job at keeping a history of the contents of
+While Git does an excellent job at keeping a history of the contents of
files, it makes no effort in keeping the file meta data, and in particular
the dates of files. Therefore when you checkout to a different branch,
files that are re-written by Git will have a newer date than the other
@@ -532,6 +532,19 @@ get more advanced in later stages of your work.
First custom commit
-------------------
+ - **Configure Git for fist time**: If you have never used Git, then you
+ have to configure it with some basic information in order to have
+ essential information in the commit messages (ignore this step if you
+ have already done it). Git will include your name and e-mail address
+ information in each commit. You can also specify your favorite text
+ editor for making the commit (`emacs`, `vim`, etc.).
+
+ ```shell
+ $ git config --global user.name "YourName YourSurname"
+ $ git config --global user.email your-email@example.com
+ $ git config --global core.editor vim
+ ```
+
- **Get this repository and its history** (if you don't already have it):
Arguably the easiest way to start is to clone this repository as shown
below. As you see, after the cloning some further corrections to your