commit dcc2f559127816c7f2aafb0c8a64d6706461ca10
parent 8fc83aef67a991384c4ac33e0916883bb8819399
Author: GeaRSiX <gearsix@tuta.io>
Date: Wed, 15 Jan 2020 19:07:14 +0000
updated README
Diffstat:
| M | README.md | | | 60 | +++++++++++++++++++++++++++++++++++++++++++++++++----------- |
1 file changed, 49 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
@@ -1,27 +1,65 @@
-# bash-scripts
-A small collection of personal Bash scripts. I usually mkdir a ~/bin folder (usually in $PATH by default) and ln -s for all the scripts I wanna use.
+# g6scripts
+A collection of personal scripts I use in linux environments
-Most of these are for convenience. I've got a few more coming that are currently sitting in my .bashrc.
+## overview
+I use most of these scripts for convenience and to save on typing. I've probably got a few more coming that are currently sitting in my .bashrc
-If any of them are do-able with a simple single-line of Bash, let me know!
+## contents
+
+1. [installing](#installing)
+2. [uninstalling](#uninstalling)
+3. [notes](#notes)
+4. [scripts](#scripts)
+
+If any of them are do-able with a simple single-line of Bash, please let me know!
+
+## installing
+I've created an install script (_another_ bash script) to help with selecting the scripts you want to install.
+```
+ usage: ./install [ARGUMENTS]
+
+ ARGUMENTS
+ -d, --dest [DESTINATION] pre-define the destination to install the scripts to
+ -a, --all install ALL the scripts, will answer "y" automatically
+ -l, --link will "ln -s" the script (not copy it), note if location of source changes then links will break
+ -h, --help print this dialog
+```
+
+## uninstalling
+I'm planning to add an uninstall bash script too, currently you'll have to manually delete all the files added though.
+
+## notes
+Personally, I like to `mkdir` a ~/bin folder (make sure ~/bin is in $PATH) and ln -s for all the scripts I wanna use (e.g. below):
+```
+ ./install --link --dest ~/bin
+```
+
+## scripts
+### strings
+Scripts related to string parsing/manipulation
-## strings
- strlen = prints the length of string ($1)
- strindex = prints the index (starting from 0) of the first character in substring ($1)
-- gfind = find all files in dir ($1) containing string ($2) - SUPER useful for debugging somebody else's code
+- gfind = find all files in dir ($1), that conatin string ($2) - SUPER useful for debugging somebody else's code
+
+### file management
-## file management
-- shh = runs binaries ($1..$n) and send stdout to /dev/null
+- shh = runs binaries ($1..$n) and send stdout to /dev/null (this probably needs a rename)
- flac2mp3 = converts .flac files ($1..$n) to .mp3 files
-- cpc = copy the contents of file $1 into file $2 - WARNING: will overwrite contents of file $2
+- cpc = copy the contents of file $1 into file $2 **WARNING: will overwrite contents of file $2**
- xopen = open files ($1..) in their xdg-default
- ```--shh``` ```-shh```
- openurl = open a .url file ($1) (see http://www.danielbrice.net/blog/opening-url-file-like-a-pro/)
- - I never use this one directly myself, instead I set it to the default binary for .url files in ~/.config/mimeapps.list and use xopen
+ - I never use this one directly myself, instead I set it as the default binary for .url files in ~/.config/mimeapps.list and use xopen
- mkdcp = make directory ($1) and copy files into it ($2..$n)
- mkdmv = make directory ($1) and move files into it ($2..$n)
- mkdnvim = make directory ($1), touch file ($2) and open file ($2) in nvim
+### depreciated
+
+- touchn = create $2 files name $1 appended with 1 to $2
+ - found out you could just use "touch ./file{0..13}"
+
# Authors
-GeaRSiX
+- GeaRSiX
