From eb716170c15fb05d6d32ca0edf42a569a562f913 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Tue, 7 Jun 2016 01:09:47 +0300 Subject: README update --- .README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/.README.md b/.README.md index ce19af7..cc32ebd 100644 --- a/.README.md +++ b/.README.md @@ -1,12 +1,14 @@ -# Cygwin configuration files +Cygwin configuration files +========================== -My Cygwin home (~) configuration files. +My Cygwin home (`~`) configuration files. -## Deployment +Deployment +---------- To deploy on a fresh Cygwin installation, execute the lines below. **Be careful** though, some of your files might get **deleted**. -Namely, your `.gitignore` file (if present) will be overwritten and basically +Namely, your ".gitignore" file (if present) will be overwritten and basically all of your files this repository isn't aware of will be deleted. Execute the lines below one-by-one and, **most importantly**, review the list of files `git clean` will delete by adding the `--dry-run` parameter. @@ -25,14 +27,14 @@ The deployment should preferably take place right after you install Cygwin. After the deployment, anyone will be able to read any of the files in the repository. To adjust the permissions so that only you can read the files, `source` -`.bashrc` (`bash` does this automatically) and execute: +".bashrc" (`bash` does this automatically) and execute: adjust_dotfiles_permissions This also makes sure the directories in the repository are accessible only by -yourself (including the `.git` directory). +yourself (including the ".git" directory). The important thing to note is that the permissions are reset each time `git` writes to a file. -It is thus necessary to execute the line above after each invokation of -`git pull`, `git checkout`, etc. +It is thus necessary to execute the line above after each invokation of `git +pull`, `git checkout`, etc. -- cgit v1.2.3