|
| 1 | +# Dotfiles |
| 2 | + |
| 3 | +The purpose of this repository is to automate as much as possible, when setting up and maintaining a Mac machine. It takes the effort out installing and configuring everything manually. |
| 4 | + |
| 5 | +You are more than welcome to fork the entire repository or cherry-pick anything you feel like. |
| 6 | + |
| 7 | +## 📖 Table of contents |
| 8 | + |
| 9 | +- [Installation](#-installation) |
| 10 | +- [Setup](#️-setup) |
| 11 | +- [Acknowledgements](#-acknowledgements) |
| 12 | +- [License](#-license) |
| 13 | + |
| 14 | +## 📦 Installation |
| 15 | + |
| 16 | +To install the dotfiles, run the following command: |
| 17 | + |
| 18 | +> [!CAUTION] |
| 19 | +> Before running [the script][setup script], be absolutely sure, you know what it does. |
| 20 | +> If you're not, then **DO NOT** run the script. Seriously, **DON'T**. |
| 21 | +
|
| 22 | +```shell |
| 23 | +bash -c "$(curl -LsS https://raw.github.com/rugaard/dotfiles/main/setup.sh)" |
| 24 | + |
| 25 | +# Skip all questions by saying "yes" everything |
| 26 | +bash -c "$(curl -LsS https://raw.github.com/rugaard/dotfiles/main/setup.sh -y)" |
| 27 | +``` |
| 28 | + |
| 29 | +That's it! ✨ |
| 30 | + |
| 31 | +## ⚙️ Setup |
| 32 | + |
| 33 | +During installation the setup script will perform the following steps: |
| 34 | + |
| 35 | +- Download the dotfiles |
| 36 | + _(by default it will suggest `~/.dotfiles`)_ |
| 37 | +- Install [Homebrew][install homebrew] |
| 38 | +- Install [Xcode command-line tools][install xcode cli tools] and [agree to license][xcode license agreement] |
| 39 | +- Install [Xcode][install xcode] |
| 40 | +- Install [applications][install applications] |
| 41 | +- Install [command-line tools][install tools] |
| 42 | +- Install [cron jobs][install cron] |
| 43 | +- Install [Quick Look][install quicklooks] addons |
| 44 | +- Install developer environments, [personal][install developer] and [work][install work] _(apps, cli tools, local server and services)_ |
| 45 | +- Install and configure [ZSH][install zsh] shell with [Prezto](https://github.com/sorin-ionescu/prezto) |
| 46 | +- Configure [`git` profile][install git] |
| 47 | +- Set custom [icons][install icons] (system and applications) |
| 48 | +- Set custom preferences for [system][preferences system] and [applications][preferences applications] |
| 49 | +- Install and configure [local settings][local script] _(ID keys, licenses and configs)_ |
| 50 | +- [Initialize][git init] and [update content][git update script] from git repository |
| 51 | +- Set [computer name](computer-name) |
| 52 | +- [Restart machine][setup script restart] |
| 53 | + |
| 54 | +## 🏆 Acknowledgements |
| 55 | + |
| 56 | +- [Cătălin Mariș’ dotfiles](https://github.com/alrra/dotfiles) is the base of my entire set of dotfiles. A huge **thank you** goes out to his hard work 🙏🏻 |
| 57 | +- [Mathias Bynens](https://github.com/mathiasbynens/dotfiles) for his legendary collection of macOS default configuration settings. |
| 58 | +- [Zach Holman](https://github.com/holman/dotfiles) and [Mislav Marohnić](https://github.com/mislav/dotfiles) for their collection of `bin` scripts. |
| 59 | + |
| 60 | +## 📝 License |
| 61 | + |
| 62 | +This project is available under the [MIT license][license]. |
| 63 | + |
| 64 | +<!-- Link labels: --> |
| 65 | +[computer-name]: macos/set_computer_name |
| 66 | +[install applications]: macos/install/applications |
| 67 | +[install cron]: macos/install/cron |
| 68 | +[install git]: macos/git_profile |
| 69 | +[install developer]: macos/install/developer |
| 70 | +[install homebrew]: macos/install/homebrew |
| 71 | +[install icons]: macos/install/icons |
| 72 | +[install quicklooks]: macos/install/quicklooks |
| 73 | +[install tools]: macos/install/tools |
| 74 | +[install work]: macos/install/work |
| 75 | +[install xcode cli tools]: https://github.com/rugaard/dotfiles/blob/main/macos/install/xcode.sh#L53-L67 |
| 76 | +[xcode license agreement]: https://github.com/rugaard/dotfiles/blob/main/macos/install/xcode.sh#L15-L30 |
| 77 | +[install xcode]: https://github.com/rugaard/dotfiles/blob/main/macos/install/xcode.sh#L102-L111 |
| 78 | +[install zsh]: macos/install/zsh |
| 79 | +[preferences applications]: macos/preferences/applications |
| 80 | +[preferences system]: macos/preferences/system |
| 81 | +[setup script]: https://github.com/alrra/dotfiles/blob/main/src/os/setup.sh |
| 82 | +[setup script restart]: https://github.com/rugaard/dotfiles/blob/main/setup.sh#L306-L315 |
| 83 | +[local script]: local |
| 84 | +[git init]: https://github.com/rugaard/dotfiles/blob/main/setup.sh#L266-L273 |
| 85 | +[git update script]: update |
| 86 | +[license]: LICENSE |
0 commit comments