commit 81b9f7fadcdfa6bc58c7f17ac34805da648b1d2e
parent a45a5294b6fe3d00099a9dcda53210955af43dbe
Author: Alex Balgavy <alex@balgavy.eu>
Date: Mon, 9 May 2022 22:15:40 +0200
Fix READMEs and remove install script
READMEs had been outdated for a while. Also I don't think it really
makes sense to have a script to install all dotfiles, so I'm removing
it. It's better to pick-and-choose what you need with `conf`.
Diffstat:
3 files changed, 18 insertions(+), 82 deletions(-)
diff --git a/README.md b/README.md
@@ -1,35 +1,17 @@
# Dotfiles & Others Repository
---
-## Installation:
-1. Clone repository as `~/.dotfiles`
-2. `cd` into repository
-3. Run `install.sh`
-
-
Remember: your configuration is *your* configuration (and this is mine).
However, if you _do_ decide to use this, I suggest that you do so more as inspiration, rather than installing everything for a full setup.
-That's why I wrote `scripts/conf` -- to allow modular configuration.
+That's why I wrote [conf](https://github.com/thezeroalpha/conf) -- to allow modular configuration (also I feel like everyone writes a dotfiles manager at some point).
You choose which configs you want to install, and it'll only install those (and back up your old files too).
-Get more info by running `scripts/conf -h`, and investigate the dotfile mappings in `./dot.map`.
-## Scripts in `dotfiles/scripts`:
+What's in this repo:
+- `dot.map`: maps the files in this repo to the necessary locations on your system, for use with [conf](https://github.com/thezeroalpha/conf)
+- `scripts/`: various scripts that I wrote myself; I use most daily.
+- `bin/`: scripts or binaries that I did not write myself
+
Before you use a custom script, read what it does.
-Scripts are described in a short comment at the top of the file.
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.
-
-## 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.
-
-* `find-photo-in-albums.app`: find the albums that contain a photo in Apple Photos
-* `wal-init.app`: an app that runs at login to set up pywal
-* `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
-* `k2pdfopt`: a tool to optimise pdfs for mobile readers
-* `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.
diff --git a/bin/README.md b/bin/README.md
@@ -0,0 +1,12 @@
+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.
+
+* `find-photo-in-albums.app`: find the albums that contain a photo in Apple Photos
+* `wal-init.app`: an app that runs at login to set up pywal
+* `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
+* `k2pdfopt`: a tool to optimise pdfs for mobile readers
+* `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.
diff --git a/install.sh b/install.sh
@@ -1,58 +0,0 @@
-#!/usr/bin/env bash
-# vim: foldmethod=marker:foldlevel=0
-
-# Preliminary checks {{{
-# Check if this directory was cloned properly
-if [ "$(pwd)" != "$HOME/.dotfiles" ]; then
- echo "Please clone this directory as $HOME/.dotfiles."
- exit 1
-fi
-
-cd "$(dirname "$0")" || { echo "Could not cd into $(dirname "$0")"; exit 1; }
-
-if ! [ -f "./install.sh" ]; then
- echo "Please cd into $HOME/.dotfiles before running the script."
- exit 1
-fi
-
-# Check if the OS is supported
-if [[ $(uname -s) == "Darwin" ]]; then
- echo "Setting up your Mac..."
- if ! command -v brew &> /dev/null; then
- /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
- fi
- if [ -f "Brewfile" ]; then
- brew bundle
- fi
-elif [[ $(uname -s) == "Linux" ]]; then
- echo "Setting up your Linux environment..."
-else
- echo "This OS isn't supported yet."
- exit 1
-fi
-
-#}}}
-
-export DOTFILES="$HOME/.dotfiles"
-
-read -rn 1 -p "Install all dotfiles? [Y/n]" yn
-echo
-case $yn in
- [Yy]* )
- yes | scripts/conf link
- echo "Dotfiles installed."
- echo "Run \`conf -h\` for more help."
- ;;
- * )
- echo "No dotfiles installed automatically."
- echo "Run \`scripts/conf -h\` for more help."
- echo "You can also add conf to your path: export PATH=$DOTFILES/scripts:$PATH"
- ;;
-esac
-
-echo "Don't forget to create a $DOTFILES/shell/secret_env with:"
-# Don't want these variables to expand
-# shellcheck disable=SC2016
-echo '- $DISCOGS_API_TOKEN'
-# shellcheck disable=SC2016
-echo '- $HOMEBREW_GITHUB_API_TOKEN'
