diff options
| author | xengineering <me@xengineering.eu> | 2022-08-05 18:23:22 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2022-08-05 18:23:22 +0200 |
| commit | 479c77a44ed3bae36cc61caf40cf8759fb42dc36 (patch) | |
| tree | 461911974af476c9884942fa8b23dccfb7b791cc | |
| parent | 0d9fc6b278f5c76626813d7b358dccf3bf5cbb44 (diff) | |
| download | scripts-479c77a44ed3bae36cc61caf40cf8759fb42dc36.tar scripts-479c77a44ed3bae36cc61caf40cf8759fb42dc36.tar.zst scripts-479c77a44ed3bae36cc61caf40cf8759fb42dc36.zip | |
Write install section in README
| -rw-r--r-- | README.txt | 29 |
1 files changed, 28 insertions, 1 deletions
@@ -4,4 +4,31 @@ scripts ------- -Some useful scripts. +This repository contains some useful scripts. + + +Installation +------------ + +You can just download one of the scripts or clone the repository to use them +like any other script. + +Personally I like to pseudo-install them under my `/home` directory. For this +purpose I first have to extend my `$PATH` environment variable with the +location for personal scripts which is standardized by the cross desktop group +(XDG). For this purpose I add this to my `~/.bashrc` file: + + PATH=~/.local/bin:$PATH + +Then I clone this repository: + + cd ~/.local/bin + git clone https://cgit.xengineering.eu/scripts + +And finally I link the scripts I need on this machine via symbolic links: + + ln -s ./scripts/url.sh url + +The result is that I can call e.g. the `url.sh` script from any location just +by typing `url`. I can also add machine-specific script in the `~/.local/bin` +folder or rename the `url.sh` script via a different name in the symlink. |