From 4a2b37920c76208a6469047b45555264b0f10bbb Mon Sep 17 00:00:00 2001
From: Calson Noah <chiacalson@gmail.com>
Date: Thu, 6 Jul 2017 13:14:12 +0100
Subject: [PATCH] updated ease of use folder

---
 ease use/INSTALL    | 47 +++++++++++++++++++++++++++++++++++++++++++++
 ease use/install.sh | 10 ++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 ease use/INSTALL
 create mode 100755 ease use/install.sh

diff --git a/ease use/INSTALL b/ease use/INSTALL
new file mode 100644
index 0000000..efbd546
--- /dev/null
+++ b/ease use/INSTALL	
@@ -0,0 +1,47 @@
+These instructions are to ease use for ubuntu users ONLY. If you do not run
+ubuntu, then manually navigate to cmdtypist directory, compile and run cmdtypist.c
+using a c compilter.
+
+Ease of use on ubuntu
+--------------------- 
+
+The sole reason for these instructions is to make it possible to run 
+cmdtypist from any directory on the command line. For this reason, it is not 
+an enquiry, it is optional. 
+
+Alternatively, you can use cmdtypist without running the ./install.sh script.
+You will need to navigate to the cmdtypist program directory each time you want to run
+cmdtypist. install.sh helps you run it from any directory. 
+
+Run cmdtypist from any directory
+--------------------------------
+
+Open a terminal and navigate to the directory containing cmdtypist and all 
+it's files.
+-In the ease use directory, run the command
+
+					./install.sh 
+to a create symbolic link to cmdtypist. Enter password to complete process.
+
+RUNNING:
+-------
+
+If you successfully executed the install.sh script, then you can run cmdtypist 
+using the command
+
+	begin; cmdtypist argument1 argument2 argument3
+
+where argument is a valid cmdtypist argument, to know all valid arguments run
+the cmdtypist help command or consult the help file which comes with the 
+program.
+
+The above instructions have been tested on ubuntu 14.04 and 16.04
+
+Note that the begin command must be followed by a semicon as shown above.
+begin helps you navigate to cmdtypist directory. Alternative, you can first 
+run begin to get into cmdtypist direcoty and then run cmdtypist.
+
+If running cmdtypist produces a "Fatal error: some files are missing error"
+then you probably did not run with begin; or some files have been deleted or 
+cannot be found.
+
diff --git a/ease use/install.sh b/ease use/install.sh
new file mode 100755
index 0000000..33de0fe
--- /dev/null
+++ b/ease use/install.sh	
@@ -0,0 +1,10 @@
+#!/bin/bash
+#Creates a symbolic link with begin to cmdtypist directory.
+echo "Enter password to create a link for cmdtypist and access it from any directory" &&
+sudo gcc cmdtypist.c -o cmdtypist &&
+echo >> $HOME/.bashrc &&
+echo "#symbolic link for cmdtypist">> $HOME/.bashrc &&
+echo "alias begin='cd $HOME/cmdtypist/'">> $HOME/.bashrc &&
+echo "alias cmdtypist='$HOME/cmdtypist/cmdtypist'">> $HOME/.bashrc &&
+mkdir $HOME/cmtypist/
+cp -r . $HOME/cmtypist/
\ No newline at end of file