Merge pull request #377 from tmc-cli/update-man-jclc

updated install.sh and added instructions

Author: Salmela

README.md

@@ -9,7 +9,7 @@
 
 #tmc-cli
 
-TMC-CLI is the command-line client for University of Helsinki's Test My Code -framework. Test My Code is used by various online programming courses for exercise testing and submission.
+TMC-CLI is the command-line client for University of Helsinki's TestMyCode -framework. TestMyCode is used by various online programming courses for exercise testing and submission.
 
 ![Demonstration](docs/demo.gif)
 
@@ -23,8 +23,19 @@ TMC-CLI is the command-line client for University of Helsinki's Test My Code -fr
 
 ##Installation
 
-Download the latest [release](https://github.com/tmc-cli/tmc-cli/releases/latest).
-If you use Linux or OS X, choose "tmc". If you use Windows, choose "tmc-cli-[VERSION].jar".
+###Using the install script (Linux/OS X only)
+
+`cd` into the directory where you wish to install TMC-CLI. Then, copy and paste the following command in your terminal:
+
+```
+curl -0 https://raw.githubusercontent.com/tmc-cli/tmc-cli/master/scripts/install.sh | bash; source ~/.bashrc
+```
+
+TMC-CLI should now be installed. You can try running it with `tmc`.
+
+###Manual installation
+
+Download the latest [release](https://github.com/tmc-cli/tmc-cli/releases/latest). If you use Linux or OS X, choose "tmc". If you use Windows, choose "tmc-cli-[VERSION].jar".
 
 If you downloaded "tmc", navigate to the download directory on your terminal and make it executable with `chmod u+x ./tmc`.
 
@@ -47,6 +58,10 @@ Tip: On Windows, use `doskey tmc="java -jar [path_to_tmc-cli.jar] $*"` in cmd.ex
 
 Now that you've installed tmc-cli, you can view all available commands by running tmc without arguments or with `tmc --help`. You can also view all available options for commands by running them with the `--help` switch, for example `tmc courses --help`.
 
+##Uninstallation
+
+Delete tmc from the directory where you downloaded it, .tmc-autocomplete.sh from your home directory and remove 'source $HOME/.tmc-autocomplete' from your shell rc file.
+
 ##Manual
 
 The Unix man page for tmc-cli is located in docs/tmc.1 in this repository. To view it, open it with `man -l tmc.1`.

docs/MANUAL.md

@@ -176,7 +176,7 @@ Once submission is successful, a shareable link will be printed.
   Do not send a message alongside the paste.
 
 `-m` `--message`
-  Give the paste as an argument instead of opening a text editor.
+  Give the message as an argument instead of opening a text editor.
 
 COMMAND: PROP
 -------------

docs/tmc.1

@@ -1,4 +1,4 @@
-.TH TMC\-CLI 1 2016\-06\-30 "Helsinki Univ. Dep. of CS" "TMC\-CLI Manual"
+.TH TMC\-CLI 1 2016\-06\-30 "TestMyCode" "TMC\-CLI Manual"
 .SH NAME
 .PP
 tmc \- Command\-line client for TestMyCode
@@ -146,7 +146,7 @@ Open the link to the paste in the default internet browser after submission.
 Do not send a message alongside the paste.
 .TP
 \fB\fC\-m\fR \fB\fC\-\-message\fR
-Give the paste as an argument instead of opening a text editor.
+Give the message as an argument instead of opening a text editor.
 .SH COMMAND: PROP
 .PP
 \fB\fCtmc\fR \fB\fCprop\fR [\fIKEY\fP] [\fIVALUE\fP] ...
@@ -176,7 +176,7 @@ blue, purple, cyan, white, none.
 \fB\fC[course directory]/.tmc.json\fR
 Course configuration and cache file. Saves the status of the username, server
 address and course's exercises. Manually editing this file may have adverse
-effects.
+effects.  
 .TP
 \fB\fC~/.config/tmc\-cli/properties.json\fR
 User configuration file. Use \fB\fCtmc prop\fR to edit properties.

scripts/install.sh

@@ -1,14 +1,44 @@
-#bin/sh
+#!/bin/bash
 
-curl -O https://github.com/tmc-cli/tmc-cli/releases/download/0.6.3/tmc
-chmod u+x ./tmc
-if ./tmc ;then
-	echo Error when installing.
-	exit 1
-fi
+RCFILE=".bashrc"
+RCPATH="$HOME/$RCFILE"
 
+echo "~ Installing TMC-CLI ~"
+echo "This install script assumes you are using Bash."
+echo "If you are using another shell, please add 'source $HOME/.tmc-autocomplete.sh' in your shell's rc file after TMC-CLI has been installed."
+echo ""
 
-source $HOME/.bashrc
+if [ ! -f $RCPATH ]; then
+	echo -e "$RCPATH not found, creating"
+	echo ""
+	touch $RCPATH
+fi
 
-echo Installation complete.
-exit 0
+if [ -f $HOME/.tmc-autocomplete.sh ]; then
+# If .tmc-autocomplete.sh is already in user's home dir, don't download it
+	if ! ((grep -Fxq "source $HOME/.tmc-autocomplete.sh" $RCPATH) \
+	|| (grep -Fxq "source \$HOME/.tmc-autocomplete.sh" $RCPATH) \
+	|| (grep -Fxq "source ~/.tmc-autocomplete.sh" $RCPATH)); then
+		echo -e ".tmc-autocomplete already exists in $HOME, but is not sourced in $RCFILE"
+		echo -e "Adding to $RCPATH"
+		echo "" >> $RCPATH
+		echo "source $HOME/.tmc-autocomplete.sh" >> $RCPATH
+		exit
+	else
+		echo "TMC-CLI is already installed. Did you forget to source your rc file?"
+		echo -e "Try 'source $RCPATH'."
+		exit
+	fi
+fi
+echo "Fetching latest release URL"
+URL=$(curl -s https://api.github.com/repos/tmc-cli/tmc-cli/releases/latest | grep '"browser_download_url"' | grep '/tmc"' | head -n 1 | cut -d '"' -f 4)
+echo "Downloading TMC-CLI"
+curl -LO $URL > ./tmc
+if [ ! -f ./tmc ]; then
+	echo "Error downloading TMC-CLI"
+	exit 1
+fi
+chmod u+x ./tmc
+./tmc > /dev/null
+echo "Installation complete"
+exit