aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--.README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/.README.md b/.README.md
index c309786..966041a 100644
--- a/.README.md
+++ b/.README.md
@@ -3,6 +3,19 @@ Cygwin configuration files
My Cygwin home (`~`) configuration files.
+Prerequisites
+-------------
+
+Some of the functionality relies on the availability of native symlinks.
+Those are indeed available on NTFS, but require Administrator privileges for
+creation.
+It likely won't bother you as long as you don't use the functions from
+".bashrc" that actually create symbolic links (you will likely see `ln`
+complaining about some access being denied in case you do).
+
+Your `CYGWIN` environment variable (on Windows) **must** include either
+`winsymlinks:native` or `winsymlinks:nativestrict`!
+
Deployment
----------
@@ -23,13 +36,16 @@ of files `git clean` will delete by adding the `--dry-run` parameter.
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_up_file_permissions_in_repo
+ ( cd && tighten_up_file_permissions_in_repo )
This also makes sure the directories in the repository are accessible only by
yourself (including the ".git" directory).