summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/chucknorris/README.md
diff options
context:
space:
mode:
authornavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
committernavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
commit02f14a9cb152561a5e44062aac79f3b700403b40 (patch)
tree2db8ebda3b7f6f8777783aeb5c60018e6e1359d8 /home/.oh-my-zsh/plugins/chucknorris/README.md
parentcbbdeb2f6b40a102a829f0c47cff052937231f00 (diff)
omz
Diffstat (limited to 'home/.oh-my-zsh/plugins/chucknorris/README.md')
-rw-r--r--home/.oh-my-zsh/plugins/chucknorris/README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/chucknorris/README.md b/home/.oh-my-zsh/plugins/chucknorris/README.md
new file mode 100644
index 0000000..655e7cf
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/chucknorris/README.md
@@ -0,0 +1,45 @@
+# chucknorris
+
+Fortunes plugin for Chuck Norris for Oh My Zsh. Perfectly suitable as MOTD.
+
+To use it add `chucknorris` to the plugins array in you zshrc file.
+
+```zsh
+plugins=(... chucknorris)
+```
+
+## Usage
+
+| Command | Description |
+| ----------- | ------------------------------- |
+| `chuck` | Print random Chuck Norris quote |
+| `chuck_cow` | Print quote in cowthink |
+
+Example: output of `chuck_cow`:
+
+```
+Last login: Fri Jan 30 23:12:26 on ttys001
+ ______________________________________
+( When Chuck Norris plays Monopoly, it )
+( affects the actual world economy. )
+ --------------------------------------
+ o ^__^
+ o (oo)\_______
+ (__)\ )\/\
+ ||----w |
+ || ||
+```
+
+## Requirements
+
+- `fortune`
+- `cowsay` if using `chuck_cow`
+
+Available via homebrew, apt, ...
+
+> [!NOTE]
+> In addition to installing `fortune`, it may be necessary to run:
+>
+> `strfile $ZSH/plugins/chucknorris/fortunes/chucknorris\n`
+>
+> (include the "\n" literally) to write the fortune data to the proper directory.