chore: Updated readme
370ede58
2 file(s) · +23 −7
| 1 | - | ## Steve's Dotfiles |
|
| 1 | + | # Dotfiles |
|
| 2 | 2 | ||
| 3 | - | Here's a collection of dotfiles that I use regularly on my MacOS development environment. If you want to use them simply copy them to their appropriate locations, majority of them being in `~/.config`. |
|
| 3 | + | A collection of MacOS dotfiles I use in my developement environment |
|
| 4 | 4 | ||
| 5 | - |  |
|
| 5 | + |  |
|
| 6 | 6 | ||
| 7 | - | **A few things to be aware of:** |
|
| 7 | + | ## Installation |
|
| 8 | 8 | ||
| 9 | - | - Alacritty is expecting a Nerd font patched verson of [Commit Mono](https://commitmono.com/) which I have included in `assets` since it is open source! |
|
| 10 | - | - The color scheme is `base16-black-metal-bathory`, which should be available in any theme plugin that offers base16 |
|
| 9 | + | To manage dotfiles I use a tool called [fling](https://github.com/bbkane/fling), which is similar to stow but in my opinion a bit more clear and fool proof. If you with to use fling to manage these dotfiles, all you have to do is the following: |
|
| 11 | 10 | ||
| 12 | - | Feel free to [reach out](mailto:hello@stevedylan.dev) if you have any questions! |
|
| 11 | + | 1. Clone the dotfiles to your machine and `cd` into the directory |
|
| 12 | + | 2. Make an empty directory where you want the files to be synced. e.g., `nvim` would be `mkdir -p ~/.config/nvim` |
|
| 13 | + | 3. Run the fling command to make a symlink: `fling link -s nvim -l ~/.config/nvim` |
|
| 14 | + | ||
| 15 | + | This will ask you to confirm the decision and create the symlink. Any time you edit your dot files the changes will actually happen in ~/dotfiles making it easier to manage them with git. |
|
| 16 | + | ||
| 17 | + | If you don't wish to use fling you can simply copy and paste these as you wish. |
|
| 18 | + | ||
| 19 | + | ## Features |
|
| 20 | + | ||
| 21 | + | - Custom theme which I've named "Darkmatter" exists in the [wezterm](wezterm/.wezterm.lua), [ghostty](ghostty/config), [nushell](nushell/darkmatter.nu), [nvim](https://github.com/stevedylandev/darkmatter-nvim), and [zed](https://github.com/stevedylandev/darkmatter-zed). |
|
| 22 | + | - A patched version of [Commit Mono](https://commitmono.com) which includes nerd fonts |
|
| 23 | + | - Custom prompt made with [starship](starship/starship.toml) |
|
| 24 | + | - Brewfile and cargofile with most of my packages (I update occasionally) |
|
| 25 | + | ||
| 26 | + | ## Questions |
|
| 27 | + | ||
| 28 | + | Feel free to [reach out](mailto:hello@stevedylan.dev) if you have any questions! I'm always more than willing to help fellow terminal nerds like me :) |
Binary file — no preview.