From 195a3c51fd83775d0ad613783ef5a10b8992d150 Mon Sep 17 00:00:00 2001 From: Raul Infante-Sainz Date: Wed, 22 Jan 2020 23:21:03 +0000 Subject: 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). --- README-hacking.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README-hacking.md') 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 -- cgit v1.2.1 From 36dd26c5baf6ae55b44e3d048f7547fadabd67fe Mon Sep 17 00:00:00 2001 From: Raul Infante-Sainz Date: Wed, 22 Jan 2020 23:31:39 +0000 Subject: Adding Raul as contributor of README-hacking.md Since I (Raul) did some changes (and I hope to do more :-)) in the `README-hacking.md', I am adding my information at the beginning of this file. --- README-hacking.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'README-hacking.md') diff --git a/README-hacking.md b/README-hacking.md index 7116cda..8e004cd 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -1,7 +1,8 @@ Reproducible paper template =========================== -Copyright (C) 2018-2020 Mohammad Akhlaghi +Copyright (C) 2018-2020 Mohammad Akhlaghi \ +Copyright (C) 2020 Raul Infante-Sainz \ See the end of the file for license conditions. This project contains a **fully working template** for doing reproducible -- cgit v1.2.1 From d95fd520e19ddbc1cd8e9f900495e9d32db742cd Mon Sep 17 00:00:00 2001 From: Raul Infante-Sainz Date: Mon, 27 Jan 2020 17:27:18 +0000 Subject: Moving basic configuration of Git section in README-hacking.md Until this commit, the small section of `README-hacking.md' in which it is explained how to do the first configuration of Git was at the beginning of the section `First custom commit'. However, it is better to have it just before the item `Your first commit' in that section. With this commit, this change has been done. Now the reader has the necessary steps for configuring Git just before it is needed for making the first commit. --- README-hacking.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'README-hacking.md') diff --git a/README-hacking.md b/README-hacking.md index 8e004cd..33d129b 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -533,19 +533,6 @@ 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 @@ -736,6 +723,19 @@ First custom commit Copyright (C) 2020 YOUR NAME ``` + - **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 -- cgit v1.2.1