aboutsummaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2020-02-05 10:03:24 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2020-02-05 10:03:24 +0100
commit24be94568eeaeb5c51071687070a4c0ffa06a1ef (patch)
tree790def3a6239fbfc1166c21c701815ce1c0b08fb /README-hacking.md
parentd180c5d8d5430f1e826ccf1ee9849a14a091b9b8 (diff)
parentd95fd520e19ddbc1cd8e9f900495e9d32db742cd (diff)
Imported Raul's additions to README-hacking.md, no conflicts
There were no conflicts in this merge.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/README-hacking.md b/README-hacking.md
index 244cb23..8e88547 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -1,7 +1,8 @@
Reproducible paper template
===========================
-Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org>
+Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org>\
+Copyright (C) 2020 Raul Infante-Sainz <infantesainz@gmail.com>\
See the end of the file for license conditions.
This project contains a **fully working template** for doing reproducible
@@ -436,7 +437,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
@@ -713,6 +714,19 @@ First custom commit
Copyright (C) 2020 YOUR NAME <YOUR@EMAIL.ADDRESS>
```
+ - **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
+ ```
+
- **Your first commit**: You have already made some small and basic
changes in the steps above and you are in the `master` branch. So, you
can officially make your first commit in your project's history. But