aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7846367
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+Cygwin configuration files
+==========================
+
+My Cygwin home (`~`) configuration files.
+
+Deployment
+----------
+
+To deploy on a fresh Cygwin installation, execute the lines below.
+**Be careful** though, some of your files will be **deleted**.
+Basically, every file/directory **not** listed in ".gitignore" 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.
+
+ git init
+ curl --silent --show-error --location https://github.com/egor-tensin/cygwin-home/raw/master/.gitignore -o .gitignore
+ git clean -d --force
+
+ git remote add origin https://github.com/egor-tensin/cygwin-home.git
+ git pull origin master
+ git branch --set-upstream-to=origin/master master
+
+The deployment should preferably take place right after you install Cygwin.
+
+File permissions
+----------------
+
+`git` doesn't preserve file permissions.
+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:
+
+ ( cd && tighten_repo_security )
+
+This also makes sure the directories in the repository are accessible only by
+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.
+
+License
+-------
+
+Distributed under the MIT License.
+See [.LICENSE.txt] for details.
+
+[.LICENSE.txt]: .LICENSE.txt