summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2010-03-12 19:19:56 +0100
committerhut <hut@lavabit.com>2010-03-12 19:19:56 +0100
commit7582555b50f058b316c04ce8ab977bed36da1585 (patch)
tree778db09861ac74ab2693969d2085f677ebc3f53c
parent76f8d548b055fad7f9652d23035d30c910ec4ca0 (diff)
downloadranger-7582555b50f058b316c04ce8ab977bed36da1585.tar.gz
more documentation
-rw-r--r--INSTALL22
-rw-r--r--README13
2 files changed, 29 insertions, 6 deletions
diff --git a/INSTALL b/INSTALL
index ee9e6285..d14d3891 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,14 +1,20 @@
 Installing
 ==========
 
-YOU DON'T NEED TO INSTALL ANYTHING.
+You don't need to install anything.
 
 You can run ranger by simply starting the executable file ranger.py
 in the top directory of this package.
+Use the --clean option and it will leave no trace whatsoever on your system.
 
 
-If you insist on conventionally install it, for security reasons for
-example, follow these instructions:
+If you insist on conventionally install it, use the package manager
+of your operating system.  If there is no package or it is out of date,
+you can also follow these instructions:
+
+
+Step by step
+============
 
 (This is all done automagically if you type `sudo make install',
 though you might want to read the Makefile first)
@@ -37,3 +43,13 @@ though you might want to read the Makefile first)
 
    (Unfortunately this feature is shell dependent.  It has been
    successfully tested with BASH and ZSH only.)
+
+
+Uninstalling
+============
+
+Use your package manager to uninstall ranger.  If you manually installed
+it, revert the steps described above.
+
+Ranger can also create a configuration directory at ~/.ranger which
+you might want to remove as well.
diff --git a/README b/README
index d133e568..de532379 100644
--- a/README
+++ b/README
@@ -69,10 +69,17 @@ If this applies to you, please include such a traceback in your report.
 Getting Started
 ---------------
 
-At first, it's a good idea to create a symlink in your bin dir:
-    sudo ln -s /path/to/ranger.py /usr/bin/ranger
+If you just want to check out ranger without installing it, type
 
-Now type in ranger to start it.
+    ./ranger.py --clean
+
+in the top directory of ranger.  By using the --clean switch, it will
+leave no trace on your system whatsoever.
+
+To properly install it, follow the instructions in the INSTALL file,
+then type:
+
+    ranger
 
 You should see 4 columns.  The third is the directory where you are at
 the moment.  To the left, there are the directories above the current