chore: Update README
c0d90264
Added better docs for users who may not be on MacOS per #1
1 file(s) · +18 −10
| 29 | 29 | ||
| 30 | 30 | [Install script source code](/install.sh) |
|
| 31 | 31 | ||
| 32 | - | ### Manual Setup |
|
| 32 | + | ### Manual / Linux Setup |
|
| 33 | 33 | ||
| 34 | - | <details> |
|
| 35 | - | <summary>Instructions</summary> |
|
| 36 | - | ||
| 37 | - | You can also create the DARKMATTER setup manually by following these steps. |
|
| 34 | + | While the install script does help give Mac users a quickstart, you can still setup DARKMATTER manually or for Linux with a few tweaks. Just follow the instructions below! |
|
| 38 | 35 | ||
| 39 | 36 | **1. Install Packages** |
|
| 40 | 37 | ||
| 41 | - | Run the following commands to install packages for DARKMATTER |
|
| 38 | + | If using MacOS you can run the following command to install the necessary dependencies |
|
| 42 | 39 | ||
| 43 | 40 | ```bash |
|
| 44 | - | brew install zsh zsh-autosuggestions zsh-syntax-highlighting starship eza zoxide aichat btop fzf |
|
| 41 | + | brew install zsh zsh-autosuggestions zsh-syntax-highlighting starship eza zoxide aichat btop fzf bat |
|
| 45 | 42 | ||
| 46 | 43 | brew install --cask ghostty |
|
| 47 | 44 | ``` |
|
| 48 | 45 | ||
| 46 | + | If you are using Linux then you can use the links below to decide how you would like to install them. Almost all of them are available on popular package managers! |
|
| 47 | + | ||
| 48 | + | - [Ghostty](https://ghostty.org/download) |
|
| 49 | + | - [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions/blob/master/INSTALL.md) |
|
| 50 | + | - [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting/blob/master/INSTALL.md) |
|
| 51 | + | - [starship](https://starship.rs/#quick-install) |
|
| 52 | + | - [eza](https://github.com/eza-community/eza/blob/main/INSTALL.md) |
|
| 53 | + | - [zoxide](https://github.com/ajeetdsouza/zoxide?tab=readme-ov-file#installation) |
|
| 54 | + | - [aichat](https://github.com/sigoden/aichat?tab=readme-ov-file#install) |
|
| 55 | + | - [btop](https://github.com/aristocratos/btop?tab=readme-ov-file#installation) |
|
| 56 | + | - [fzf](https://github.com/junegunn/fzf?tab=readme-ov-file#installation) |
|
| 57 | + | - [bat](https://github.com/sharkdp/bat) |
|
| 58 | + | ||
| 49 | 59 | **2. Setup zsh** |
|
| 50 | 60 | ||
| 51 | 61 | Create a file in your home directory called `.zshrc` with the following contents |
|
| 69 | 79 | bindkey '^j' history-search-forward |
|
| 70 | 80 | ||
| 71 | 81 | # Source zsh plugins |
|
| 82 | + | # If you are not using MacOS / Homebrew make sure to adjust per the instructions for each tool |
|
| 72 | 83 | source $(brew --prefix)/share/zsh-autosuggestions/zsh-autosuggestions.zsh |
|
| 73 | 84 | source $(brew --prefix)/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh |
|
| 74 | 85 | ||
| 133 | 144 | click-repeat-interval = 500 |
|
| 134 | 145 | ``` |
|
| 135 | 146 | ||
| 136 | - | ||
| 137 | 147 | **4. Install CommitMono** |
|
| 138 | 148 | ||
| 139 | 149 | DARKMATTER uses a open sourced font called [CommitMono](https://commitmono.com) and in this repo you can download special Nerd Font patched versions of it, which include nice icons used by several of the programs already installed. Check them out in the [`assets`](/assets) folder in this repo. |
|
| 141 | 151 | **5. Open Ghostty!** |
|
| 142 | 152 | ||
| 143 | 153 | After following these steps you should be able to open Ghostty and you will have the DARKMATTER setup |
|
| 144 | - | ||
| 145 | - | </details> |
|
| 146 | 154 | ||
| 147 | 155 | ## Features |
|
| 148 | 156 | ||