move files to src; add README.txt

12 files changed, 36 insertions, 1 deletions

diff --git a/Makefile b/Makefile
index e417538..7803bc8 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,5 @@
 BINDIR = /usr/local/bin
-BINARIES = sliceweasel.lib.sh ioslay-mgr.sh firestart firestartx ioslay-firefox
+BINARIES = firestart firestartx $(addprefix src/,sliceweasel.lib.sh ioslay-mgr.sh ioslay-firefox)
 SUDO != [ "$$(id -u)" = 0 ] || echo sudo
 
 .PHONY: install install-bin
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..492e278
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,35 @@
+TO INSTALL
+==========
+
+Type this command to install:
+
+  make install
+
+TO RUN FIREFOX
+==============
+
+Then you can use the two commands:
+
+  firestart  - start Firefox in a CGroup sandbox          (best performance)
+  firestartx - start Firefox in a CGroup and X server sandbox  (recommended)
+
+Within the `firefox` systemd service, a background service called `ioslay` will
+be started by `ioslay-mgr.sh`.
+
+The launching of Firefox through either of these commands launches a watchdog
+process that kills Firefox processes when they are spinning the disk.
+
+FIRESTART AND FIRESTARTX
+========================
+
+firestart <firefox arguments>
+
+  This command starts Firefox in a CGroup sandbox with at most half of system
+  memory available. It monitors IO usage and kills web browser tab processes
+  when IO is saturated.
+
+firestartx <firefox arguments>
+
+  This runs `firestart` with $DISPLAY set to a virtual X11 screen that runs in a
+  window. This prevents Firefox from popping anything up outside of its window
+  and prevents Firefox from locking up the X server input.
diff --git a/firefox-update b/firefox-update
-Subproject 72ffbda9c4f4d9a7a9f3b34c0a965611d7222a8
+Subproject 4facb7f7dc9542db0bb23648a6c113082517c8b
diff --git a/cgroup-show-each-new-process b/src/cgroup-show-each-new-process
index d1473f1..d1473f1 100755
--- a/cgroup-show-each-new-process
+++ b/src/cgroup-show-each-new-process
diff --git a/fireslay b/src/fireslay
index 3c68ad5..3c68ad5 100755
--- a/fireslay
+++ b/src/fireslay
diff --git a/ioslay-firefox b/src/ioslay-firefox
index 41aa6a4..41aa6a4 100755
--- a/ioslay-firefox
+++ b/src/ioslay-firefox
diff --git a/ioslay-mgr.sh b/src/ioslay-mgr.sh
index 56ab849..56ab849 100755
--- a/ioslay-mgr.sh
+++ b/src/ioslay-mgr.sh
diff --git a/slice b/src/slice
index 44ae13e..44ae13e 100755
--- a/slice
+++ b/src/slice
diff --git a/sliceuser b/src/sliceuser
index 16d441f..16d441f 100755
--- a/sliceuser
+++ b/src/sliceuser
diff --git a/sliceweasel b/src/sliceweasel
index f9df2c8..f9df2c8 100755
--- a/sliceweasel
+++ b/src/sliceweasel
diff --git a/sliceweasel.lib.sh b/src/sliceweasel.lib.sh
index 549e1e8..549e1e8 100755
--- a/sliceweasel.lib.sh
+++ b/src/sliceweasel.lib.sh
diff --git a/your-fired.sh b/src/your-fired.sh
index 59efaf7..59efaf7 100644
--- a/your-fired.sh
+++ b/src/your-fired.sh