aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDuncaen <mail@duncano.de>2017-02-12 23:34:52 +0100
committerDuncaen <mail@duncano.de>2017-02-13 01:12:05 +0100
commit61fe557f4c1b9d8c51efba12e342496c4148a5ae (patch)
tree27352679f00e5d2dc69629f26d6644d4d5b69906
parentf871abfffe3162084ab014477f1ad74ed77604bd (diff)
downloaddotfiles-61fe557f4c1b9d8c51efba12e342496c4148a5ae.tar.gz
README: add README.sh template and some text
-rw-r--r--README57
-rw-r--r--README.md2
-rwxr-xr-xREADME.sh41
3 files changed, 98 insertions, 2 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..9285ab2
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+dotfiles
+========
+
+This repository contains my dotfiles, runit services and small scripts.
+Many scripts are inspired by or copied from leah2 [0].
+
+usage
+-----
+
+ $ ./install.sh
+ # ./install-root.sh
+
+deps
+----
+
+- extarce [1] - trace exec() calls system-wide
+- lr [2] - list files, recursively
+- snooze [3] - run a command at a particular time
+- xe [4] - simple xargs and apply replacement
+
+- dmenu [5]
+- dwm [6]
+- st [7]
+
+bin/
+----
+
+- diffed [-CHT] [-pN] [-s SUBST -r REPL] [-x EXCLUDE] - filter for unified diffs
+- dmoji - dmenu based emoji picker
+- fzpsgrep [pattern] - psgrep with fzy selection
+- git merge-pr [PRNUM][@REMOTE] [GIT-AM FLAGS...] - list or apply GitHub pull request from command-line
+- grurls - substitute and group urls
+- nginx-here [DIR] [PORT] - serve current directory (or DIR) on PORT (or 8080)
+- oomtop - lists processes by oom score
+- psgrep [pattern]
+- sprunge FILES... - paste to sprunge.us
+- ssh-copy-term - copy terminfo via ssh
+- swaptop - show most swap-using processes
+- timer [hh:mm[:ss]]... [[0-9]*[h|m|s]]... -- prog [args...]
+- unpatch [-pN] FILES... - re-generate patch from files and their .orig version
+- yiff - colored diff
+
+Proudly presented by
+
+ # git ls-files bin/ | xe awk 'NR==2{if(sub("# ","- ")){print}}'
+
+links
+-----
+
+[0] http://chneukirchen.org/dotfiles/
+[1] https://github.com/chneukirchen/extrace
+[2] https://github.com/chneukirchen/lr
+[3] https://github.com/chneukirchen/snooze
+[4] https://github.com/chneukirchen/xe
+[5] http://tools.suckless.org/dmenu/
+[6] http://dwm.suckless.org/
+[7] http://st.suckless.org/
diff --git a/README.md b/README.md
deleted file mode 100644
index 422d8e8..0000000
--- a/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-dotfiles
-========
diff --git a/README.sh b/README.sh
new file mode 100755
index 0000000..d599924
--- /dev/null
+++ b/README.sh
@@ -0,0 +1,41 @@
+#!/bin/sh
+# README.sh - generate README file
+
+cat <<! | ./bin/grurls
+dotfiles
+========
+
+This repository contains my dotfiles, runit services and small scripts.
+Many scripts are inspired by or copied from [leah2](http://chneukirchen.org/dotfiles/).
+
+usage
+-----
+
+ $ ./install.sh
+ # ./install-root.sh
+
+deps
+----
+
+- [extarce](https://github.com/chneukirchen/extrace) - trace exec() calls system-wide
+- [lr](https://github.com/chneukirchen/lr) - list files, recursively
+- [snooze](https://github.com/chneukirchen/snooze) - run a command at a particular time
+- [xe](https://github.com/chneukirchen/xe) - simple xargs and apply replacement
+
+- [dmenu](http://tools.suckless.org/dmenu/)
+- [dwm](http://dwm.suckless.org/)
+- [st](http://st.suckless.org/)
+
+bin/
+----
+
+$(git ls-files bin/ | xe awk 'NR==2{if(sub("# ","- ")){print}}')
+
+Proudly presented by
+
+ # git ls-files bin/ | xe awk 'NR==2{if(sub("# ","- ")){print}}'
+
+links
+-----
+
+!