Merge pull request #36 from primis/master

Added an Install script

Author: pimterry

Makefile

@@ -0,0 +1,41 @@
+PREFIX ?= /usr/local
+BASH_COMPLETION_DIR := $(shell pkg-config --silence-errors --variable=completionsdir bash-completion) 
+# pkg-config adds a space for some reason, we have to strip it off.
+BASH_COMPLETION_DIR := $(strip $(BASH_COMPLETION_DIR))
+USERDIR ?= $(HOME)
+
+# The @ symbols make the output silent.
+
+install:
+	@if [ $(BASH_COMPLETION_DIR) ]; then \
+		cp notes.bash_completion "$(BASH_COMPLETION_DIR)/notes"; \
+	else \
+		printf \
+"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.\n\n"; \
+	fi # Small test for bash completion support
+	@install -m755 -d $(PREFIX)/bin/
+	@install -m755 notes $(PREFIX)/bin/
+	@install -m777 -d $(USERDIR)/.config/notes/
+	@install -m777 config $(USERDIR)/.config/notes/
+	@install -d $(PREFIX)/share/man/man1/
+	@install notes.1 $(PREFIX)/share/man/man1/
+
+	@mandb 1>/dev/null 2>&1 || true # Fail silently if we don't have a mandb
+
+	@printf \
+"Notes has been installed to $(PREFIX)/bin/notes. \
+A configuration file has also been created at $(USERDIR)/.config/notes/config, \
+which you can edit if you'd like to change the default settings.\n\n\
+Get started now by running 'notes new my-note' \
+or you can run 'notes help' for more info.\n"
+
+uninstall:
+	rm -f $(PREFIX)/bin/notes
+	rm -f $(PREFIX)/share/man/man1/notes.1
+	rm -f $(BASH_COMPLETION_DIR)/notes
+	rm -f $(USERDIR)/.config/notes/config.example
+
+	@printf "\nNotes has now been uninstalled.\n"

README.md

@@ -21,13 +21,20 @@ This is just one tool in the chain. `notes` is a command line tool, and some peo
 
 ## How do I install this?
 
-Download `notes`, `chmod +x`, put it in your `$path`. This will probably do it:
+### Automatic:
 
 ```bash
-curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes > /usr/local/bin/notes && chmod +x /usr/local/bin/notes
+curl -L https://rawgit.com/pimterry/notes/latest-release/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.
+### Manual:
+
+Download `notes`, `chmod +x`, put it in your `$path`. This will probably do it:
+
+```bash
+curl https://cdn.rawgit.com/pimterry/notes/latest-release/notes > /usr/local/bin/notes && chmod +x /usr/local/bin/notes
+```
 
 #### Installing auto completion
 
@@ -42,25 +49,33 @@ Installing the completions might be as follows:
 **Bash**
 
 ```bash
-curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes.bash_completion > /usr/share/bash-completion/completions/notes
+curl https://cdn.rawgit.com/pimterry/notes/latest-release/notes.bash_completion > /usr/share/bash-completion/completions/notes
 ```
 
 **Zsh**
 
 On *buntu based distros and OSX:
 ```bash
-curl -L https://rawgit.com/pimterry/notes/master/_notes > /usr/local/share/zsh/site-functions/_notes
+curl -L https://rawgit.com/pimterry/notes/latest-release/_notes > /usr/local/share/zsh/site-functions/_notes
 ```
 
 On other Unix distros:
 
 ```bash
-curl -L https://rawgit.com/pimterry/notes/master/_notes > /usr/share/zsh/site-functions/_notes
+curl -L https://rawgit.com/pimterry/notes/latest-release/_notes > /usr/share/zsh/site-functions/_notes
 ```
 
 You'll need to open a new shell for this to take effect.
 
-# How do I configure this?
+## 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
+curl -L https://rawgit.com/pimterry/notes/latest-release/install.sh | bash -s -- uninstall
+```
+
+## 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.
 

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

@@ -0,0 +1,38 @@
+#!/bin/sh
+
+# This is an install script for notes
+
+# Yay, Echo self documents! :D
+echo "Checking for root..."
+    [ "$(whoami)" != "root" ] && exec sudo -- "$0" -s -- "$@"
+
+# This has to be defined after root elevation or script will fail.
+function assertInstalled() {
+    for var in "$@"; do
+        if ! which $var &> /dev/null; then
+            echo "$var is required but not installed, exiting."
+            exit 1
+        fi
+    done
+}
+
+# Make sure we have everything actually installed that we need to install this.
+echo "Checking for dependencies..."
+    assertInstalled bash curl tar mktemp install make
+
+# Variable Definitions go here. 
+user_home=`eval echo ~$SUDO_USER`
+extract_dir=$(mktemp -d /tmp/notes.XXXXX)
+
+echo "Downloading and extracting Notes from Repository..."
+    curl -L https://api.github.com/repos/pimterry/notes/tarball/latest-release | tar -xzp -C $extract_dir --strip-components=1
+if [ "$1" != "uninstall" ]; 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."

notes.1

@@ -0,0 +1,54 @@
+.TH NOTES 1
+.SH NAME
+notes \ - Simple delightful note taking, with more unix and less lock-in.
+.SH SYNOPSIS
+.B notes
+\fICOMMAND\fR
+.SH DESCRIPTION
+.B notes
+is a simple command line tool that makes note taking simpler.
+When run without a command, the help screen will appear and will offer a brief
+description of availible commands.
+
+\fBnotes\fR will run the default editor for your distribution when opening a 
+note. You can set $EDITOR in your shell to override it.
+\fBnotes\fR uses a configuration file located at \fB~/.config/notes/config\fR.
+This file overrides any settings in your rc file.
+.SH COMMANDS
+.TP
+.BR new ", " n " " \fR[\fINAME\fR]
+Open your text editor with a new note, with given name.
+If no name is given, a quick note will be created with an auto-generated
+name.
+.TP
+.BR find ", " f " " \fR[\fIPATTERN\fR]
+Searches for notes using the given pattern, returning all matches. If no
+pattern is given, returns every note.
+.TP
+.BR grep ", " g " " \fIPATTERN\fR
+Searches the contents of all notes for the given pattern. Returns all matches.
+.TP
+.BR search ", " s " " \fIPATTERN\fR
+Combination of find and grep.
+.TP
+.BR ls " " \fR[\fIDIRECTORY\fR]
+Lists all notes within \fIDIRECTORY\fR. Lists contents of $NOTES_DIRECTORY if 
+no path is provided.
+.TP
+.BR open ", " o
+Opens $NOTES_DIRECTORY in your file explorer.
+.TP
+.BR open ", " o " "\fINAME\fR
+Opens note \fINAME\fR using your configured editor. \fINAME\fR can either be an
+absolute path or relative to $NOTES_DIRECTORY.
+.TP
+.BR rm " "\fR[\fB\-r\fR | \fB\-\-recursive\fR] " "\fINAME\fR
+Removes \fINAME\fR. If \-r or \-\-recursive is given, folders will be removed.
+.SH AUTHORS
+Notes was created by Tim Perry, who is still the maintainer. Numerous
+contributions have been submitted via pull requests on github.
+<\fBhttp://github.com/pimterry/notes\fR>.
+
+If you have a clone of notes.git, the output of \fBgit-shortlog\fR(1) and
+\fBgit-blame\fR(1) can show you the authors for specific parts of the project.
+