From 72809cc3639f8261496cca7348408814dc48fcc5 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Wed, 28 Apr 2021 22:16:29 +0000 Subject: README update --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c30bb0f..4cd138b 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,18 @@ Configuration file sharing [![Test](https://github.com/egor-tensin/config-links/actions/workflows/test.yml/badge.svg)](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/ -- cgit v1.2.3