Changes suggested by @pimterry

Signed-off-by: primis <[email protected]>

Author: primis

Makefile

@@ -4,15 +4,29 @@ BASH_COMPLETION_DIR := $(shell pkg-config --variable=completionsdir bash-complet
 BASH_COMPLETION_DIR := $(strip $(BASH_COMPLETION_DIR))
 USERDIR ?= $(HOME)
 
+# The @ symbols make the output silent.
+# the \033[0m stuff is ansi color escape codes.
+
 install: 
 	@if [ -d $(BASH_COMPLETION_DIR) ]; then \
-	 	echo $(BASH_COMPLETION_DIR);\
-		cp notes.bash_completion "$(BASH_COMPLETION_DIR)/notes";\
+		cp notes.bash_completion "$(BASH_COMPLETION_DIR)/notes"; \
+	else \
+		echo "Bash Completion was not installed, because the directory was" \
+		"not found. if you have bash completion installed, follow the" \
+		"README (https://github.com/pimterry/notes#installing-bash-completion)" \
+		"to manually install it."; \
 	fi # Small test for bash completion support
-	install -m755 -D notes $(PREFIX)/bin/notes
-	install -m777 -D config.example $(USERDIR)/.config/notes/config.example
-	install -D notes.1 $(PREFIX)/share/man/man1/notes.1
-	mandb 1>/dev/null
+	@install -m755 -D notes $(PREFIX)/bin/notes
+	@install -m777 -D config $(USERDIR)/.config/notes/config
+	@install -D notes.1 $(PREFIX)/share/man/man1/notes.1
+	@mandb 1>/dev/nulli 2>&1 # Fail silently if we don't have a mandb
+	@echo -e "Notes has been installed to \033[0;32m$(PREFIX)/bin/notes." \
+	"\n\033[0mA configuration file has also been created at" \
+	"\033[0;32m$(USERDIR)/.config/notes/config,\033[0m" \
+	"which you can edit if you'd like to change the default settings." \
+	"\nGet started now by running \033[0;32mnotes open my-new-note\033[0m" \
+	"Or you can run \033[0;32mnotes help\033[0m for more info"
+	
 uninstall:
 	rm -f $(PREFIX)/bin/notes
 	rm -f $(PREFIX)/share/man/man1/notes.1

README.md

@@ -21,15 +21,47 @@ This is just one tool in the chain. `notes` is a command line tool, and some peo
 
 ## How do I install this?
 
+The easy way is:
 
 ```bash
-curl https://cdn.rawgit.com/pimterry/notes/master/install.sh | bash
+curl https://rawgit.com/pimterry/notes/master/install.sh | bash
 ```
+This will install `notes`, a default configuration, a man page, and bash completion if possible.
 
-By default your notes live in ~/notes, but you can change that to anywhere you like by setting the `$NOTES_DIRECTORY` environmental variable. See [how do I configure this?](#how-do-i-configure-this) for more details.
+The manual way is:
+
+Download `notes`, `chmod +x`, put it in your `$path`. This will probably do it:
+
+```bash
+curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes > /usr/local/bin/notes && chmod +x /usr/local/bin/notes
+```
+
+#### Installing Bash completion
+
+`notes` includes bash autocompletion, to let you tab-complete commands and your note names. This requires Bash > 4.0 and [bash-completion](https://github.com/scop/bash-completion) to be installed - it's probably available from your friendly local package manager.
+
+To enable completion for notes, copy the completion script into your bash completion directory, and it should be automatically loaded. The bash completion directory is `/usr/share/bash-completion/completions/` on a typical Debian install, or `/usr/local/etc/bash_completion.d/` on OSX with `bash-completion` from homebrew. You may be able to find your own bash completion directory by running the following command:
+
+    pkg-config --variable=completionsdir bash-completion
+
+Installing the completions might be as follows:
+
+```bash
+curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes.bash_completion > /usr/share/bash-completion/completions/notes
+```
+
+You'll need to open a new shell for this to take effect.
+
+## What if I want to uninstall this?
+If you used the automated install script to install notes, you can uninstall it the same way by running:
+```bash
+export uninstall=1 && curl https://rawgit.com/pimterry/notes/master/install.sh | bash
+```
 
 ## How do I configure this?
 
+By default your notes live in ~/notes, but you can change that to anywhere you like by setting the `$NOTES_DIRECTORY` environmental variable. See [how do I configure this?](#how-do-i-configure-this) for more details.
+
 To get started with you'll want to set `$EDITOR` to your favourite text editor, and probably `$NOTES_DIRECTORY` to the directory in which you'd like to use to store your notes (this defaults to `~/notes`). You'll typically want to set these as environment variables in your `.bashrc`, `.zshrc`, or similar.
 
 There are also more complex options available. You can set any configuration properties either in the environment, or in a config file (stored in `~/.config/notes/config`), with settings in config overriding those in your environment. This allows you to configure a different `$EDITOR` for notes to everything else, if you like. The config file is a good choice for more complex set ups, but probably not worth worrying about to start with. We've included an example config in this repo for you ([config.example](config.example)) that you can copy if you like. 

config.example renamed to config

@@ -3,10 +3,10 @@
 # This config is case sensitive
 
 # Set the editor that notes are opened with
-EDITOR=nano
+# EDITOR=nano
 
 # Change the quicknote format to get rid of the word "quicknote"
-QUICKNOTE_FORMAT="%Y-%m-%d"
+# QUICKNOTE_FORMAT="%Y-%m-%d"
 
 # Set extension to plain txt instead of markdown
-NOTES_EXT="txt"
+#NOTES_EXT="txt"

install.sh

@@ -21,13 +21,17 @@ echo "Checking for Dependencies..."
 
 # Variable Definitions go here. 
 user_home=`eval echo ~$SUDO_USER`
-bash_completion_dir=`pkg-config --variable=completionsdir bash-completion 2>/dev/null`
 extract_dir=$(mktemp -d /tmp/notes.XXXXX)
 
 echo "Downloading and Extracting Notes from Repository..."
     curl -L https://api.github.com/repos/pimterry/notes/tarball | tar -xzp -C $extract_dir --strip-components=1
-echo "Installing notes..."
+if [ "$uninstall" != "1" ]; then
+    echo "Installing notes..."
     cd $extract_dir && make USERDIR=$user_home
+else
+    echo "Uninstalling notes..."
+    cd $extract_dir && make uninstall USERDIR=$user_home
+fi
 echo "Cleaning Up..."
     rm -rf $extract_dir
 echo "All done."