From 6a74133b804524c451c30c64b99f0559c6d47e40 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Thu, 29 Apr 2021 03:52:09 +0300 Subject: rename the scripts For consistency with the distribution packages, mostly. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4cd138b..0c0aab0 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,10 @@ This description is obviously confusing; see the complete usage example below. Usage ----- -Symlinks are managed by `update.sh`. +Symlinks are managed by `links-update`. ``` -usage: update.sh [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run] +usage: links-update [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run] ``` Pass the `--help` flag to this script to examine its detailed usage @@ -62,7 +62,7 @@ In this example, the symlinks to files in "../src" must appear in > echo "$DEST" /test/dest -> ./update.sh --shared-dir ../src/ +> ./links-update --shared-dir ../src/ ... > tree /test/dest/ -- cgit v1.2.3 From cef4642ae006edd4fc177dcc03b9ace62115c745 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Thu, 29 Apr 2021 04:02:41 +0300 Subject: README: add more badges --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0c0aab0..9e87b0f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ 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) +[![Packages (Debian)](https://github.com/egor-tensin/config-links/actions/workflows/debian.yml/badge.svg)](https://github.com/egor-tensin/config-links/actions/workflows/debian.yml) +[![Publish (Launchpad)](https://github.com/egor-tensin/config-links/actions/workflows/ppa.yml/badge.svg)](https://github.com/egor-tensin/config-links/actions/workflows/ppa.yml) * Store your files in a repository. * Checkout it on any machine. -- cgit v1.2.3 From 351e33032eaa34e223abb64cec5b5dd51703d8d9 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Thu, 29 Apr 2021 04:06:24 +0300 Subject: README: update --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9e87b0f..a52fb28 100644 --- a/README.md +++ b/README.md @@ -24,23 +24,24 @@ corresponding symlink is then deleted too). The default database file name is "links.bin", maintained in the top-level directory with shared files. -This description is obviously confusing; see the complete usage example below. +For a complete usage example, see below. Usage ----- -Symlinks are managed by `links-update`. +Symlinks are created & maintained by `links-update`. ``` usage: links-update [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run] ``` -Pass the `--help` flag to this script to examine its detailed usage -information. +To remove all symlinks, use `links-remove`. -A complete usage example is given below. -In this example, the symlinks to files in "../src" must appear in -"/test/dest". +``` +usage: links-remove [-h|--help] [-d|--database PATH] [-s|--shared-dir DIR] [-n|--dry-run] +``` + +In this example, symlinks to files in "../src" must appear in "/test/dest". ``` > tree /test/dest/ @@ -80,7 +81,7 @@ In this example, the symlinks to files in "../src" must appear in 5 directories, 2 files ``` -For more realistic usage examples, see +For my personal real-life usage examples, see * my [Linux/Cygwin environment], * configuration files for various [Windows apps]. -- cgit v1.2.3 From 985c99e9c1fd65a3447f4c0d91e7eb00f34eb639 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Thu, 29 Apr 2021 11:22:31 +0300 Subject: README: add "Installation" --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a52fb28..5807115 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,15 @@ directory with shared files. For a complete usage example, see below. +Installation +------------ + +* For Arch Linux, use the [AUR package]. +* For Ubuntu, use the [PPA]. + +[AUR package]: https://aur.archlinux.org/packages/config-links/ +[PPA]: https://launchpad.net/~egor-tensin/+archive/ubuntu/config-links + Usage ----- -- cgit v1.2.3 From d52850255b96ba9bcae4386956bdfab06148fc03 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Thu, 29 Apr 2021 11:23:42 +0300 Subject: rename the project --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5807115..a2fc4fd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -Configuration file sharing -========================== +Config 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) [![Packages (Debian)](https://github.com/egor-tensin/config-links/actions/workflows/debian.yml/badge.svg)](https://github.com/egor-tensin/config-links/actions/workflows/debian.yml) -- cgit v1.2.3