diff options
authorRahiel Kasim <rahielkasim@gmail.com>2017-07-30 15:50:02 +0200
committerRahiel Kasim <rahielkasim@gmail.com>2017-07-30 15:50:02 +0200
commitd4c70cf27339c8cd52cb6ff05148a67ed034627b (patch)
parentadf7c93c330d192b74c6eb9bbddfb7462fddf4e1 (diff)
mention directory to add to PATH for cargo binaries
2 files changed, 5 insertions, 1 deletions
diff --git a/Cargo.toml b/Cargo.toml
index b166d15..eed9d69 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -6,6 +6,6 @@ license = "Apache-2.0"
readme = "README.md"
homepage = "https://github.com/rahiel/pwds"
keywords = ["shell", "prompt", "pwd"]
-description = "print the path of the current working directory, shortly"
+description = "Print the path of the current working directory, shortly."
diff --git a/README.md b/README.md
index c367ead..ea569ca 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,8 @@ Install pwds with cargo:
``` shell
cargo install pwds
+The directory `~/.cargo/bin` needs to be in your PATH for your shell to find the
+`pwds` binary. Follow [this guide][path] if you need help.
Then you need to customize your PS1 in your shell's initialization file, e.g.
`.bashrc`. Here is a standard prompt, the `\w` is an escape code for the current
@@ -33,6 +35,8 @@ PS1='\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]$(pwds)\[\033[00m\]\$ '
and enjoy a smaller prompt!
+[path]: https://www.cpu.re/installing-programs-from-non-system-package-managers-without-sudo/
# Customization
By default, paths with more than 16 characters are shortened by replacing