README.md

Overview

This project is a collection of my personal dotfiles for my macOS environment.

It contains the configuration files for the following tools:

• Miniconda
• Git
• Zsh
• iTerm2
• yabai
• Homebrew
• GitHub

This project is the continuity of these previous projects:

• Easy-Git
• Easy-Env
• Yabai-Setup
• Mac-Setup

Getting Started

• Overview
• Getting Started
  • Documentation
  • Setting up
    • Prerequisites
    • Install
    • Post-installation
  • Troubleshooting
  • Future improvements
  • Contributing
  • License

Documentation

Provide where to find to the documentation of the project. (ex: Structure of the project)

• General utility packages
• Dev packages

It may include a link to an important reference.

Setting up

Prerequisites

• macOS Sonoma (14.x.x)
• Internet connectivity
• A terminal

Install

After booting up your Mac for the first time, restart it and follow the steps below.

Open a terminal using spotlight : [cmd + space] then type "terminal" and press enter.

Then execute the command below and follow the instructions:

curl -s https://raw.githubusercontent.com/MorganKryze/.dotfiles/main/scripts/bootstrap.sh | zsh

Post-installation

Add cmd+d as a shortcut to Show Launchpad in System Preferences > Keyboard > Shortcuts > Launchpad & Dock.

Start by opening each of the ObjectiveSee apps and grant them the necessary permissions when prompted.

Then you may open the rest of the apps at least once and make the necessary configurations.

After setting up at least Bitwarden and Arc / Zen, sign in to your GitHub and GitLab accounts.

Then, run the following command to create the SSH connections to your Git accounts:

create-git-ssh-connections

Finally, run the following command launch the yabai service and grant the necessary permissions:

yabai-start

Your machine is now set up and ready to use!

Troubleshooting

No Issues reported so far!

Future improvements

• document the brew packages (similar to Mac-Setup)
• document and improve Easy-Git work
• document and improve Easy-Env work
• document and improve Yabai-Setup work

Contributing

If you want to contribute to the project, you can follow the steps described in the CONTRIBUTING file.

License

This project is licensed under the MIT License - see the LICENSE file for details.