Added readme

1 files changed, 25 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..0e3f5fa
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+I regularly amass a mass of junk files in my ~/public_html that I don't need.
+Most of these were uploaded to share something on IRC / email / IM, and aren't
+needed after some number of days.
+
+To address this, I wrote a small garbage collector in C. Its file retention
+period is shamelessly stolen from the kind folks at https://ttm.sh/ .
+
+SETUP:
+
+    Edit the paths in cleanup.c
+    compile cleanup.c
+    add a daily cronjob that calls cleanup
+
+USAGE:
+
+    cleanup
+        -v verbose
+        -n dry run
+        -x filename
+            exclude filename from cleanup
+
+TO UPLOAD:
+
+    I have a flaky shell script 'ptmp' that scps files to the right directory
+    with a temporary filename.