aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2020-05-03 21:49:37 +1200
committerTom Ryder <tom@sanctum.geek.nz>2020-05-03 21:49:37 +1200
commit75e67b7714fe5e58033467767f8b0c415ce068a1 (patch)
tree0954a7d87e67723461ac2532c8734358367f123d
parentMerge branch 'hotfix/v8.25.2' into develop (diff)
downloaddotfiles-75e67b7714fe5e58033467767f8b0c415ce068a1.tar.gz
dotfiles-75e67b7714fe5e58033467767f8b0c415ce068a1.zip
Update recommended path in documentation
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index 774031a0..f8201416 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,8 @@ into a personal suite of custom Unix tools.
Installation
------------
- $ git clone https://sanctum.geek.nz/code/dotfiles.git ~/.dotfiles
- $ cd ~/.dotfiles
+ $ git clone https://sanctum.geek.nz/code/dotfiles.git ~/.local/share/dotfiles
+ $ cd ~/.local/share/dotfiles
$ git submodule init
$ git submodule update
$ make
@@ -56,16 +56,16 @@ The remaining files can be installed with the other `install-*` targets. Try
### Configuration
To save a set of `make` targets useful for a specific user or host, you can
-save them in a newline-separated file `~/.dotfiles.conf`, and install using
+save them in a newline-separated file `~/.local/share/dotfiles.conf`, and install using
that with the special `install-conf` target. This can include variable
settings, too:
$ cd
- $ cat .dotfiles.conf
+ $ cat .local/share/dotfiles.conf
install-bash
install-bin
EMAIL=you@example.com
- $ make -C .dotfiles install-conf
+ $ make -C .local/share/dotfiles install-conf
Tools
-----
@@ -156,16 +156,16 @@ testing `BASH_VERSINFO` appropriately.
A terminal session with my prompt looks something like this:
~$ ssh remote
- remote:~$ cd .dotfiles
- remote:~/.dotfiles(master+!)$ git status
+ remote:~$ cd .local/share/dotfiles
+ remote:~/.local/share/dotfiles(master+!)$ git status
M README.md
M bash/bashrc.d/prompt.bash
A init
- remote:~/.dotfiles(master+!)$ foobar
+ remote:~/.local/share/dotfiles(master+!)$ foobar
foobar: command not found
- remote:~/.dotfiles(master+!)<127>$ sleep 5 &
+ remote:~/.local/share/dotfiles(master+!)<127>$ sleep 5 &
[1] 28937
- remote:~/.dotfiles(master+!){1}$
+ remote:~/.local/share/dotfiles(master+!){1}$
The hostname is elided if not connected via SSH. The working directory with
tilde abbreviation for `$HOME` is always shown. The rest of the prompt expands