aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..290e089
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+doomsh
+======
+
+Use `ulimit` to severely restrict your Bash shell's resources, and see how long
+you can last before segfaulting or giving up.
+
+The author highly recommends you create a dummy user to run this, so that you
+don't end up munging important files in your `HOME`.
+
+ $ sudo useradd -m doomguy
+ $ sudo -i -u doomguy
+ $ git clone https://sanctum.geek.nz/code/doomsh.git
+ $ cd doomsh
+ $ ./doomsh
+
+Not really important or useful in any way, but kind of fun to see what breaks
+when resources are really tight, especially when it exposes problems in
+programs like failing to check for NULL returns from `malloc(3)`.
+
+On the author's machine, at level 5, even `ls(1)` doesn't work, let alone Vim.
+
+If you're really crazy, you'll try and launch X11 processes from it, and watch
+them twitch as they die.
+
+READ THE LICENSE. THE AUTHOR WAIVES ALL RESPONSIBILITY FOR ANYTHING THIS DOES
+TO YOUR COMPUTER, YOUR DATA, OR YOUR DOG.
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under an [MIT License][2].
+
+[1]: https://sanctum.geek.nz/
+[2]: https://www.opensource.org/licenses/MIT