summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Linehan <patientulysses@gmail.com>2012-06-06 21:04:46 -0400
committerJason Linehan <patientulysses@gmail.com>2012-06-06 21:04:46 -0400
commitbff1f00f929d135a13371f258447c46d2addbb97 (patch)
tree45127406280edbbdfe20142e52de7200666e0e48
parentb1ed1816e325f3ed37a410691c66836289240f0a (diff)
downloadcloth-bff1f00f929d135a13371f258447c46d2addbb97.tar.gz
cloth-bff1f00f929d135a13371f258447c46d2addbb97.tar.bz2
cloth-bff1f00f929d135a13371f258447c46d2addbb97.zip
Quick README
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..0102f20
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+cloth is a toy web server designed to be as small as possible,
+so that it can be read and understood in one sitting.
+
+To use it, run
+
+ ./cloth <PORT> <WWW_ROOT> &
+
+where the '&' forks the process into the background in most
+shells. To stop it, try
+
+ pkill cloth
+
+If you don't have any content or just want to test it out,
+try providing the included www folder as a the WWW_ROOT path.
+
+NOTE: the command line arguments must NOT be relative paths,
+ i.e., no '~/foo' or '../../baz'
+