Add documentation

README-MY-SETUP.md

@@ -0,0 +1,120 @@
+My Shell Setup
+==============
+
+Much if my information comes from [here](https://www.bretfisher.com/shell/) and his [YouTube video](https://www.youtube.com/watch?v=KeSIJQEinJA).
+
+Note that this will backup and replace your existing `~/.zshrc` file
+
+You'll need zsh to install Oh My Zsh. Run `zsh --version` to check if you have it.
+
+macOS
+-----
+
+* install [HomeBrew](https://brew.sh/) (probably already installed)
+* install [iTerm2](https://www.iterm2.com/)
+* install prereqs
+  * need to install [Nerd Fonts](https://www.nerdfonts.com) (may want other fonts but must be `Nerd` variety)
+
+    ```shell
+    brew tap homebrew/cask-fonts
+    brew install --cask font-fantasque-sans-mono
+    brew install --cask font-hack-nerd-font
+    brew install --cask font-fira-nerd-font
+    ```
+
+  * Configure iTerm2 to use one of the nerd fonts
+  * needed for `oh-my-zsh` module `autojump`
+
+    ```shell
+    brew install autojump
+    brew install terminal-notifier
+    ```
+
+  * install `ls` replacement `exa`
+
+    ```shell
+    brew install exa
+    ```
+
+* continue to [Common Install Steps](#common-install-steps)
+
+Linux
+-----
+
+* install [Tilex](https://gnunn1.github.io/tilix-web/)
+
+  ```shell
+  apt install tilix
+  ```
+
+* install prereqs
+  * If which zsh not installed, then install with `sudo apt install zsh`. Next, change your login shell with `chsh -s $(which zsh)`
+
+  * need to install [Nerd Fonts](https://www.nerdfonts.com) (may want other fonts but must be `Nerd` variety)
+    * I download [FiraCode](https://github.com/ryanoasis/nerd-fonts/releases/download/v2.3.3/FiraCode.zip), exand, open Nautilus and double-click on each non-Windows font
+  * configure Tilix to use the Nerd font
+  * install `autojump`
+
+    ```(shell)
+    sudo apt install autojump
+    ```
+
+* continue to [Common Install Steps](#common-install-steps)
+
+Windows
+-------
+
+* Install [Windows Terminal](https://github.com/microsoft/terminal)
+* Recommend using WSL2 with Ubuntu and zsh installed there, but may be able to use Git Bash
+* other steps TBD
+* continue to [Common Install Steps](#common-install-steps)
+
+Common Install Steps
+--------------------
+
+* install [Oh My Zsh](https://ohmyz.sh/) customized [fork](https://github.com/fklassen/ohmyzsh)
+  * fork `fklassen` fork of `oh-my-zsh` to your personal account, or simpler yet use `fklassen/ohmyzsh` if you don't plan to modify anything
+
+    ```shell
+    https://github.com/fklassen/ohmyzsh/fork
+    ```
+
+  * if you forked, optionally modify `README.md` and `tools/install.sh` to point to your repo so that you don't need `REPO=fklassen/ohmyzsh` during installation
+  * optionally customize forked repo to match your preferences
+  * run installer
+    * if you are using `fklassen/ohmyzsh` ...
+
+      ```shell
+      sh -c "$(curl -fsSL <https://raw.githubusercontent.com/fklassen/ohmyzsh/master/tools/install.sh>)"
+      ```
+
+    * if you forked your own repo ...
+
+      ```shell
+      REPO=<your_github_id>/ohmyzsh sh -c "$(curl -fsSL <https://raw.githubusercontent.com/fklassen/ohmyzsh/master/tools/install.sh>)"
+      ```
+
+  * optionally configure by editing '~/.zshrc` (see [Getting Started](https://github.com/ohmyzsh/ohmyzsh/wiki#getting-started))
+    * I personally like to make a symbolic link so I can commit my changes to my forked config
+
+      ```(shell)
+      cd
+      ln -sf ~/.oh-my-zsh/templates/zshrc.zsh-template .zshrc
+      ```
+
+* install [Starship](https://starship.rs)
+  * run installer
+
+    ```(shell)
+    curl -sS https://starship.rs/install.sh | sh
+    ```
+
+  * take a copy Starship config file
+
+    ```(shell)
+    mkdir -p ~/.config
+    cd ~/.config
+    ln -s ~/.oh-my-zsh/templates/starship.toml
+    ```
+
+* Start a terminal session

templates/starship.toml

@@ -0,0 +1,19 @@
+# Get editor completions based on the config schema
+"$schema" = 'https://starship.rs/config-schema.json'
+
+# Inserts a blank line between shell prompts
+add_newline = true
+
+# Use custom format
+#format = '''
+#[┌───────────────────>](bold green)
+#[│](bold green)$directory$rust$package
+#[└─>](bold green) '''
+
+# Replace the '❯' symbol in the prompt with '➜'
+[character] # The name of the module we are configuring is 'character'
+success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'
+
+# Disable the package module, hiding it from the prompt completely
+[package]
+disabled = true

templates/zshrc.zsh-template

@@ -71,9 +71,9 @@ DISABLE_UNTRACKED_FILES_DIRTY="true"
 # Example format: plugins=(rails git textmate ruby lighthouse)
 # Add wisely, as too many plugins slow down shell startup.
 plugins=(
-    git
     alias-finder
     aliases
+    aws
     autojump
     colored-man-pages
     command-not-found
@@ -87,6 +87,7 @@ plugins=(
     emoji
     extract
     fd
+    git
     jfrog
     man
     ssh-agent
@@ -129,4 +130,4 @@ export MANPATH="/usr/local/man:/usr/local/ssl/share/man:$MANPATH"
 [ -f /usr/local/etc/profile.d/autojump.sh ] && . /usr/local/etc/profile.d/autojump.sh
 ZSH_ALIAS_FINDER_AUTOMATIC=true
 
-#eval "$(starship init zsh)"
+eval "$(starship init zsh)"