chore: Updated readme
3a67b3f8
1 file(s) · +91 −3
| 29 | 29 | ||
| 30 | 30 | [Install script source code](/install.sh) |
|
| 31 | 31 | ||
| 32 | + | ### Manual Setup |
|
| 33 | + | ||
| 32 | 34 | <details> |
|
| 33 | - | <summary>###Manual Setup</summary> |
|
| 35 | + | <summary>Instructions</summary> |
|
| 34 | 36 | ||
| 35 | 37 | You can also create the DARKMATTER setup manually by following these steps. |
|
| 36 | 38 | ||
| 134 | 136 | ||
| 135 | 137 | **4. Install CommitMono** |
|
| 136 | 138 | ||
| 137 | - | 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` folder in this repo. |
|
| 139 | + | 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. |
|
| 138 | 140 | ||
| 139 | 141 | **5. Open Ghostty!** |
|
| 140 | 142 | ||
| 142 | 144 | ||
| 143 | 145 | </details> |
|
| 144 | 146 | ||
| 145 | - | ## Usage |
|
| 147 | + | ## Features |
|
| 148 | + | ||
| 149 | + | Thanks to the programs installed you will have several nice quality of life features available in your terminal! |
|
| 150 | + | ||
| 151 | + | ### AI Shell |
|
| 152 | + | ||
| 153 | + | Through [AIChat](https://github.com/sigoden/aichat) you can have a great AI experience in your terminal. Start by running the command `ai` which will create a config and ask for your preferred and API key if applicable. If you want to use a local model with a tool like `ollama` use the `openai-compatible` option and use `http://localhost:11434/v1` as the base URL with no API key. |
|
| 154 | + | ||
| 155 | + |  |
|
| 156 | + | ||
| 157 | + | Once installed you can use AI in multiple ways in your terminal. |
|
| 158 | + | ||
| 159 | + | Start an AI chat session, or do a single prompt |
|
| 160 | + | ||
| 161 | + | ```bash |
|
| 162 | + | ai |
|
| 163 | + | ||
| 164 | + | ai why is the sky blue? |
|
| 165 | + | ``` |
|
| 166 | + | ||
| 167 | + | Have AI generate a shell command |
|
| 168 | + | ||
| 169 | + | ```bash |
|
| 170 | + | ai -e find my current IP address |
|
| 171 | + | ``` |
|
| 172 | + | ||
| 173 | + | Generate just code |
|
| 174 | + | ||
| 175 | + | ```bash |
|
| 176 | + | ai -c React useEffect hook usage |
|
| 177 | + | ``` |
|
| 178 | + | ||
| 179 | + | AIChat has a lot more capabilities we can't cover here, so by all means [check out the docs](https://github.com/sigoden/aichat/wiki/Chat-REPL-Guide) for more info! |
|
| 180 | + | ||
| 181 | + | ### Better `zsh` |
|
| 182 | + | ||
| 183 | + | By installing `zsh-autosuggestions` and `zsh-syntax-highlighting` we're able to get a much better auto complete setup with zero zsh frameworks or package managers! |
|
| 184 | + | ||
| 185 | + | // gif |
|
| 186 | + | ||
| 187 | + | ### Better `cd` with `zoxide` |
|
| 188 | + | ||
| 189 | + | As you use `cd` to move into different directories, zoxide will gain memory of where you've been and make it easier to navigate to it later. For example, if you used `cd ~/Desktop`, anytime after that you can just use `cd Desktop` to navigate directly to that folder, without needing the full path. You can also use partial words like `cd Desk`. |
|
| 190 | + | ||
| 191 | + | // gif |
|
| 192 | + | ||
| 193 | + | ### Better `ls` with `eza` |
|
| 194 | + | ||
| 195 | + | `eza` provides a more visually appealing `ls` command that uses NerdFont icons from the patched [CommitMono](https://commitmono.com) font installed with your setup. |
|
| 196 | + | ||
| 197 | + | // gif |
|
| 198 | + | ||
| 199 | + | ### Better `htop` with `btop` |
|
| 200 | + | ||
| 201 | + | Nothing is more satisfying than viewing your system processes, and there's not a better way to do that than with [`btop`](https://github.com/aristocratos/btop). For best color results, update the theme to `TTY` by hitting `ESC` then going to `Settings`. |
|
| 202 | + | ||
| 203 | + | // gif |
|
| 204 | + | ||
| 205 | + | ## Themes |
|
| 206 | + | ||
| 207 | + | DARKMATTER comes with it's own custom theme that I modeled after my favorite theme of all time, Black Metal Bathory. Thankfully Ghostty comes with hundreds of themes you can choose from; just run the following command to see them all! |
|
| 208 | + | ||
| 209 | + | ```bash |
|
| 210 | + | ghostty +list-themes |
|
| 211 | + | ``` |
|
| 212 | + | ||
| 213 | + | This will let you preview any theme available in Ghostty, and when you've found the one you want, simply update the `~/.config/ghostty/config` file with the `theme` property. So if you wanted `catppuccin-mocha` you would use the following |
|
| 214 | + | ||
| 215 | + | ``` |
|
| 216 | + | theme = catppuccin-mocha |
|
| 217 | + | ``` |
|
| 218 | + | ||
| 219 | + | Also make sure to delete the custom color config that came with DARKMATTER. |
|
| 220 | + | ||
| 221 | + | > [!INFO] |
|
| 222 | + | > For more info on how to use Ghostty themes or Ghostty in general [check out the docs](https://ghostty.org/docs) |
|
| 223 | + | ||
| 224 | + | ## Prompt |
|
| 225 | + | ||
| 226 | + | For those who may not know, the prompt is what the terminal greets you with. DARKMATTER uses [Starship](https://starship.rs) as it includes a wonderful default setup but also allows for deep customization. An easy way to change it is to check out the [presets list](https://starship.rs/presets/#presets) in the Starship docs. |
|
| 227 | + | ||
| 228 | + | // gif |
|
| 229 | + | ||
| 230 | + | > [!INFO] |
|
| 231 | + | > For more info on customizing your prompt [check out the docs](https://starship.rs) |
|
| 232 | + | ||
| 233 | + | ## Questions |
|