diff options
| -rw-r--r-- | README.md | 124 |
1 files changed, 60 insertions, 64 deletions
diff --git a/README.md b/README.md index 0bb63192de23..66adce2847da 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,15 @@ # My P(ersonal) C(omputer) Settings -I'm documenting this primarily for personal use. This reposity contains shell configs, vim configs, -emacs configs, a list of commonly used applications, and other items. +I'm documenting this primarily for personal use. This reposity contains shell +configs, vim configs, emacs configs, a list of commonly used applications, and +other items. -The overall goal of this repository is to reduce the time it takes to adopt a new computer and equip -it with the necessary tooling to do meaningful work. +The overall goal of this repository is to reduce the time it takes to adopt a +new computer and equip it with the necessary tooling to do meaningful work. -Ironically, I prefer to use a Mac or a Linux as my personal computer, so hopefully the connotation -associated with "PCs" as Windows boxes isn't misleading. - - -# Python Scripts or Bash Scripts? - -Let me start by saying that I enjoy shell scripting. I even love the spirit of shell scripting: a -hacker's preferred tool for quickly piecing together logic to make his or her life easier. As a -staunch supporter of building one's own tools, shell-scripting has been a staple of my programming -career for multiple years. It is, however, this same hackish spirit of POSIX shell scripting that -has motivated me to seek more robust tools. - -I have decided to switch to Python scripts in lieu of shell scripts to improve the code readability -and maintainability, and write more powerful cross-platform installation and configuration scripts. -While I do worry that the switch to Python will eventually dull my knowledge of shell scripts, I -feel secure for a few reasons. Firstly, Python is widely available on most computers. Secondly, most -of my day-to-day tasks on the CLI require shell knowledge. - -I am reluctant to leave the piping syntax behind, but I am encouraged by third-party Python -libraries, such as [plumbum](http://plumbum.readthedocs.io/en/latest/), that are attempting to -provide this syntactic convenience to Python. This should not be seen as my farewell to Bash -scripting. That is too severe. Instead, I see this as a necessary upgrade for my tooling and my -foray into writing more sophisticated tools for myself and others. +Ironically, I prefer to use a Mac or a Linux as my personal computer, so +hopefully the connotation associated with "PCs" as Windows boxes isn't +misleading. # SSH @@ -37,8 +18,8 @@ Here are a few useful tips for working with SSH. ## ssh_config -Instead of creating shell aliases and functions for conveniently accessing remote nodes over SSH, -edit your `~/.ssh/config` file. +Instead of creating shell aliases and functions for conveniently accessing +remote nodes over SSH, edit your `~/.ssh/config` file. Instead of doing this... @@ -59,7 +40,8 @@ Host ec2 ## sshfs -SSHFS enables seamless file transfers from your local machine to a remote machine. +SSHFS enables seamless file transfers from your local machine to a remote +machine. To install, run: @@ -68,24 +50,26 @@ $ brew cask install osxfuse $ brew install sshfs ``` -Assuming your remote machine is configured in your `~/.ssh/config` (see above), you can mount your -remote machine's home directory on your local machine like so: +Assuming your remote machine is configured in your `~/.ssh/config` (see above), +you can mount your remote machine's home directory on your local machine like +so: ```bash $ mkdir ~/ec2 $ sshfs ec2:/home/ubuntu ~/ec2 -o reconnect,follow_symlinks ``` -Now your remote machine's home directory can be accessed using the `~/ec2` directory. This directory -can be transparently treated as if it were an ordinary local directory. To illustrate how easy it is -to use, let's install `Vundle`, a Vim package manager, on our remote machine. +Now your remote machine's home directory can be accessed using the `~/ec2` +directory. This directory can be transparently treated as if it were an ordinary +local directory. To illustrate how easy it is to use, let's install `Vundle`, a +Vim package manager, on our remote machine. ```bash $ git clone https://github.com/VundleVim/Vundle.vim.git ~/ec2/.vim/bundle/Vundle.vim ``` -Voila! We now have `Vundle` installed on our ec2 instance without needing to SSH into that machine -ourselves. That's all there is to it. +Voila! We now have `Vundle` installed on our ec2 instance without needing to SSH +into that machine ourselves. That's all there is to it. # GnuPG @@ -96,11 +80,11 @@ ourselves. That's all there is to it. ## Commentary -By default `gpg2` interfaces with `gpg-agent`. `gpg` does not unless `--use-agent` is specified. -I suggest using `gpg2`, but if you must use `gpg`, add the following entry to `~/.gnupg/gpg.conf`: +By default `gpg2` interfaces with `gpg-agent`. `gpg` does not unless +`--use-agent` is specified. I suggest using `gpg2`, but if you must use `gpg`, +add the following entry to `~/.gnupg/gpg.conf`: -``` -use-agent +``` use-agent ``` ## GnuPG + Git @@ -117,11 +101,10 @@ $ git config --global gpg.program gpg2 ## GnuPG + GPG-Agent -Setup `gpg-agent` to use password caching by adding the following entries to `~/.gnupg/gpg-agent.conf`: +Setup `gpg-agent` to use password caching by adding the following entries to +`~/.gnupg/gpg-agent.conf`: -``` -default-cache-ttl 300 -max-cache-ttl 3600 +``` default-cache-ttl 300 max-cache-ttl 3600 ``` @@ -139,9 +122,12 @@ $ tic $TERM.ti ### TrueColor -Note: make sure that the terminal you are using supports TrueColor (hint: recent version of iTerm2 do). Also make sure that the tmux version you are using supports TrueColor (hint: versions north of 2.2 should). +Note: make sure that the terminal you are using supports TrueColor (hint: recent +version of iTerm2 do). Also make sure that the tmux version you are using +supports TrueColor (hint: versions north of 2.2 should). -At each step of the way, test TrueColor using the following shell pipeline (hint: the gradients should be smooth): +At each step of the way, test TrueColor using the following shell pipeline +(hint: the gradients should be smooth): ```bash $ curl https://raw.githubusercontent.com/JohnMorales/dotfiles/master/colors/24-bit-color.sh | bash @@ -160,7 +146,8 @@ set termguicolors Enable TrueColor in your `~/.tmux.conf` (already done in this repository): -NOTE: This may conflict with the setting for italics. Need to verify to confirm / disconfirm this (pending). +Note: This may conflict with the setting for italics. Need to verify to confirm +/ disconfirm this (pending). ``` set -ga terminal-overrides ",xterm-256color-italic:Tc" @@ -169,13 +156,16 @@ set -ga terminal-overrides ",xterm-256color-italic:Tc" ### Italics -In the file `/configs/shared/.tmux.conf` there is a line to add italics support to tmux: +In the file `/configs/shared/.tmux.conf` there is a line to add italics support +to tmux: ``` set -g default-terminal "tmux-256color-italic" ``` -The `$TERM` entry, `tmux-256color-italic`, will be unavailable until you add the file, `tmux-256color-italic`, to your terminal database. You can do this with the following command: +The `$TERM` entry, `tmux-256color-italic`, will be unavailable until you add the +file, `tmux-256color-italic`, to your terminal database. You can do this with +the following command: ```bash $ tic ~/pc_settings/tmux-256color-italic @@ -197,7 +187,8 @@ $ hub clone 'powerline/fonts' $ cd fonts && ./install.sh && cd ../ && rm -rf fonts ``` -Lastly, ensure that the line in `.tmux.conf` that sources the `powerline.conf` is uncommented: +Lastly, ensure that the line in `.tmux.conf` that sources the `powerline.conf` +is uncommented: ``` run-shell "powerline-daemon -q" @@ -206,31 +197,36 @@ source "/usr/local/lib/python2.7/site-packages/powerline/bindings/tmux/powerline ## Commonly used applications (Mac) -* Emacs OS X - text editor -* dash - provides quick access to offline documentation (use with Alfred) -* Alfred - replaces macOS Spotlight and integrates with external Apps like Dash -* iTerm 2 - substitute for standard `Terminal.app` that ships with OS X -* homebrew - CLI for procuring third-party applications -* slate.js - resize and move your windows with keyboard shortcuts -* oh my zsh - a full suite of z-shell extensions -* docker - for running containers and virtual environments -* f.lux - modulates the blue amount from the screen throughout the day + +Thankfully `brew cask` simplifies the installation of many of my commonly used +applications: + +```bash +$ brew cask install alfred dash slack 1password slack emacs dropbox iterm2 flux docker +``` + +The following applications need to be downloaded / installed manually: + +* oh-my-zsh: a full suite of z-shell extensions +* homebrew: CLI for procuring third-party applications +* slate.js: resize and move your windows with keyboard shortcuts ## Commonly used fonts * Install [Hasklig](https://github.com/i-tu/Hasklig) for ligature support in Elm, Elixir, etc * Install [Operator Mono](http://www.typography.com/blog/introducing-operator) for expressive monospaced font * Install powerline fonts -* Install `Neotree` fonts -* add Adobe Source Code Pro font for shell and text editors +* Install Adobe Source Code Pro font for shell and text editors ### Ligature Support -To support ligatures make sure Hasklig is installed (link at the bottom). Ensure that you are using an terminal emulator that supports ligatures. With both of these tasks completed, ligatures should function in Neovim. +To support ligatures make sure Hasklig is installed (link at the bottom). Ensure +that you are using an terminal emulator that supports ligatures. With both of +these tasks completed, ligatures should function in Neovim. ## Miscellaneous notes * Map `<CAPS_LOCK>` key to `<ESC>` * Increase key-repeat rate * Decrease key-repeat-delay -* Increase trackpad / mouse speed +* Increase mouse speed |