diff options
| author | Egor Tensin <Egor.Tensin@gmail.com> | 2021-04-28 22:16:29 +0000 |
|---|---|---|
| committer | Egor Tensin <Egor.Tensin@gmail.com> | 2021-04-29 01:17:35 +0300 |
| commit | 72809cc3639f8261496cca7348408814dc48fcc5 (patch) | |
| tree | cc6d30928bd63a3fd9fcf1a0efb4ffe069b91afe /README.md | |
| parent | bin/*.sh -> *.sh (diff) | |
| download | config-links-72809cc3639f8261496cca7348408814dc48fcc5.tar.gz config-links-72809cc3639f8261496cca7348408814dc48fcc5.zip | |
README updatev0.1
Diffstat (limited to '')
| -rw-r--r-- | README.md | 17 |
1 files changed, 10 insertions, 7 deletions
@@ -3,12 +3,18 @@ Configuration file sharing [](https://github.com/egor-tensin/config-links/actions/workflows/test.yml) -A simple tool to help share (configuration) files across multiple machines. -Actual files are stored in directories with names roughly matching the `%.+%` +* Store your files in a repository. +* Checkout it on any machine. +* Create and maintain symlinks to these files easily. + +How it works +------------ + +Actual files are stored in directories with names matching the `%VAR_NAME%` pattern. The part between the percent signs is the name of an environment variable. -Every file in such a directory gets a symlink in the directory pointed to by -the environment variable. +Every file in such directory gets a symlink in the directory pointed to by the +environment variable. Directory hierarchies are preserved. A database of symlinks is maintained in case a shared file is deleted (the @@ -35,9 +41,6 @@ In this example, the symlinks to files in "../src" must appear in "/test/dest". ``` -> pwd -/cygdrive/d/workspace/personal/config-links - > tree /test/dest/ /test/dest/ |