aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorGravatar Tom Willemse2014-03-23 13:56:32 +0100
committerGravatar Tom Willemse2014-03-23 13:56:32 +0100
commitbfc51dc982043f27583875c453cc9e0f37f002ce (patch)
tree4ae4dbf4ada7243470fe16f7d8ea911a63402078 /README.org
parent889b64c9af807b2cec1adf7d4f5611d2fc48502d (diff)
downloadsti-bfc51dc982043f27583875c453cc9e0f37f002ce.tar.gz
sti-bfc51dc982043f27583875c453cc9e0f37f002ce.zip
Add more docs
Diffstat (limited to 'README.org')
-rw-r--r--README.org35
1 files changed, 27 insertions, 8 deletions
diff --git a/README.org b/README.org
index b2e11c0..cfbf69e 100644
--- a/README.org
+++ b/README.org
@@ -1,13 +1,32 @@
-sti, the Stupid Tool Installer.
+#+TITLE: Stupid Tool Installer
+#+STARTUP: showall
+#+HTML_HEAD: <link type="text/css" rel="stylesheet" href="https://ryuslash.org/org.css" />
+
+~sti~ is a simplistic tool installer written in Bash. It offers simple
+commands to help installing little tools your or otherss have written.
+This document will try to explain to you how to use it.
+
+Bug reports, feature requests, asking for help, and such things can be
+sent to [[mailto:tom@ryuslash.org][tom@ryuslash.org]].
* 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=.
+ The =sti= source is stored in a git repository. It can be cloned from
+ the URL ~git://ryuslash.org/sti.git~.
+
+ Installing =sti= is simple. Just put the =sti= executable file somewhere
+ in your =$PATH= and you can start using it. You can also download the
+ executable anywhere and use it from there.
+
+ Another option is to use =sti= to install itself. That way it should
+ be easier to keep it updated as well. To do this, download sti from,
+ for example, the git repository, and run it with the sti git
+ repository url. For example:
-* Usage
+ #+BEGIN_EXAMPLE
+ $ curl http://code.ryuslash.org/sti/plain/sti
+ $ ./sti install git://ryuslash.org/sti.git
+ #+END_EXAMPLE
- For usage information run the program without any arguments to see
- the help text.
+ Since =sti= installs all executables in =~/usr/bin= you should make sure
+ that this directory is included in =$PATH=.