Add README

1 files changed, 35 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..193b4ea
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+README for drop-caches
+======================
+
+`drop-caches` is a really simple utility that tells the kernel to
+empty its disk caches, by writing the appropriate value to the
+`/proc/sys/vm/drop_caches` file. The `drop-caches` utility could
+be replaced with a simple `echo` command, except:
+
+1. I can't remember the full pathname of the proc file.
+2. I can't remember the right value to write to the file.
+3. Redirection doesn't work well with sudo.
+
+So I wrote a tiny utility for this. Sue me.
+
+
+Legalese
+--------
+
+Copyright 2013  Lars Wirzenius
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+=*= License: GPL-3+ =*=
+