aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorGravatar Tom Willemse2014-03-10 21:14:29 +0100
committerGravatar Tom Willemse2014-03-10 21:14:29 +0100
commit4141202579b8b099d0bae3de505682b1c19daf9a (patch)
tree42f17485ce6e7c75df668679abb3be674dd4792e /README.org
parentc5ac5dafcb9d4fd01889fb4efd7ca01f7469b4e2 (diff)
downloadsti-4141202579b8b099d0bae3de505682b1c19daf9a.tar.gz
sti-4141202579b8b099d0bae3de505682b1c19daf9a.zip
Add license information and minor documentation
Diffstat (limited to 'README.org')
-rw-r--r--README.org13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..b2e11c0
--- /dev/null
+++ b/README.org
@@ -0,0 +1,13 @@
+sti, the Stupid Tool Installer.
+
+* Installation
+
+ Installation can be done by cloning the git repository and linking
+ the ~sti~ executable to a place in path. You could also use this
+ cloned version of sti to install itself by specifying the same URL
+ you used to clone it and making sure that =~/usr/bin= is in your =PATH=.
+
+* Usage
+
+ For usage information run the program without any arguments to see
+ the help text.