commit b668dc4f9e36541ce027640414afd3ae05dabf16
parent e01c9bd6e20a9e3c99ed56a5b5ac4211bd3e7367
Author: Alex Balgavy <a.balgavy@gmail.com>
Date: Tue, 26 Feb 2019 18:49:14 +0100
Updated README
Former-commit-id: cf2d6c33d2f21519d4f0ebd4d6bbcecda563e4a9
Diffstat:
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
@@ -8,24 +8,18 @@
However, I suggest that you use this more as inspiration than just installing everything for a full setup. Your configuration is *your* configuration.
-## Scripts in `dotfiles/bin`:
+## Scripts in `dotfiles/scripts`:
Before you use a custom script, read what it does. Some may be a bit buggy, I haven't tested them on all systems.
If you read a script and see some improvements that could be made, let me know. I'm always down to learn more stuff.
-Scripts:
-* `AMSTracker`: Retrieves x, y, and z values from AMS (Apple Motion Sensor) hardware.
* `anythingtogif`: converts (almost) anything to a gif. Usage: `anythingtogif clip.mov clip.gif`. Backed by ffmpeg.
-* `bfg.jar`: the big gun. A repo cleaner to remove sensitive data.
-* `class-dump`: dumps classes from binary file
* `clonedisk`: clones one disk to another
-* `Desktop Changer.app`: an Automator application that changes the desktop background to a random image on login
* `conf`: the script to manage dotfiles. run `conf` to show available commands.
* `dashedit.rb`: script to allow Dash submissions from the commandline. Largely useless to anyone except me.
* `epub-convert`: uses Calibre's ebook converter program to convert anything to an epub
* `executable`: my first script. Makes any file executable, along with further options. Usage: `executable file.sh`
* `ffmpeg-split.py`: split videos using ffmpeg. [Here's the README.](ffmpeg-split-README.md)
-* `gfx2gfx`: convert SWF into PDF. Usage: `gfx2gfx page.swf -o page.pdf`
-* `icalBuddy`: can extract information about events from the iCal application
+*
* `it-style`: can find and set the genre in a track in iTunes (along with its Ruby helper), using the Discogs database (you need an API key, set $DISCOGS_API_TOKEN in your profile). Usage: click/play a track in iTunes, and run the program.
* `linkdir`: symlink all files/folders from source dir to target dir. Usage: `linkdir $source` to create symlinks in cwd, `linkdir $source $target` otherwise.
* `mdvl`: markdown renderer in Python
@@ -41,9 +35,19 @@ Scripts:
* `tag`: a command-line `mp3tagger.jar`. Usage: `tag filename.mp3`
* `topdf`: converts a file to a PDF using cupsfilter. Works well on docx files. Usage: `topdf file [file2 file3 file4...]`
* `updatemaster`: the ultimate all-in-one update script (Brew, Cask, MAS, pip, etc.). Run with `-h` to see options.
-* `upx.out`: Fixes a fucked CORE keygen. Check Info.plist in bundle. If the version is lower than system version, and the crash log says "UPX compressed binary", just run `upx.out -d $coreKeygenBinaryPath` and you good.
* `usbmux`, `tcprelay`: port forwarding. If you want to SSH to a jailbroken iPhone over USB, you can run `tcprelay 22:2222` to forward local port 2222 to the iPhone's SSH port (22), and then `ssh -p 2222 root@localhost`.
* `vimwiki_md`: convert vimwiki files to markdown, using the vimwiki_md_ex expressions file for sed. Still a work-in-progress and probably very buggy.
* `vwtags.py`: generate ctags tag files for vimwiki documents.
* `wattpad-scrape`: downloads a Wattpad book as an EPUB file. Usage: `wattpad-scrape $wattpad_url`
+
+## Binaries in `dotfiles/bin`:
+These are third-party binaries that I didn't write. I don't take credit for any of them. I only have them in the folder for convenience.
+
+* `Desktop Changer.app`: an Automator application that changes the desktop background to a random image on login
+* `AMSTracker`: Retrieves x, y, and z values from AMS (Apple Motion Sensor) hardware.
+* `bfg.jar`: the big gun. A repo cleaner to remove sensitive data.
+* `class-dump`: dumps classes from binary file
+* `gfx2gfx`: convert SWF into PDF. Usage: `gfx2gfx page.swf -o page.pdf`
+* `icalBuddy`: can extract information about events from the iCal application
+* `upx.out`: Fixes a fucked CORE keygen. Check Info.plist in bundle. If the version is lower than system version, and the crash log says "UPX compressed binary", just run `upx.out -d $coreKeygenBinaryPath` and you good.
* `xld`: X lossless decoder CLI.
