Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/morgankryze/.dotfiles
Personal dotfiles for my macOS environment.
https://github.com/morgankryze/.dotfiles
brew conda dotfiles dotfiles-macos git github yabai zsh
Last synced: 15 days ago
JSON representation
Personal dotfiles for my macOS environment.
- Host: GitHub
- URL: https://github.com/morgankryze/.dotfiles
- Owner: MorganKryze
- License: mit
- Created: 2024-03-08T01:21:56.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-10T15:14:06.000Z (about 2 months ago)
- Last Synced: 2024-10-04T21:43:16.615Z (about 1 month ago)
- Topics: brew, conda, dotfiles, dotfiles-macos, git, github, yabai, zsh
- Language: Shell
- Homepage:
- Size: 220 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# .dotfiles
> Personal dotfiles for my macOS environment.
## Getting Started
### Introduction
This project is a collection of my personal dotfiles for my macOS environment. It contains the configuration files for the following tools:
- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
- [Git](https://git-scm.com/)
- [Zsh](https://www.zsh.org/)
- [iTerm2](https://iterm2.com/)
- [yabai](https://github.com/koekeishiya/yabai)
- [Homebrew](https://brew.sh/)
- [GitHub](https://github.com)
This project is the continuity of these previous projects:
- [Easy-Git](https://github.com/MorganKryze/easy-git)
- [Easy-Env](https://github.com/MorganKryze/easy-env)
- [Yabai-Setup](https://github.com/MorganKryze/yabai-setup)
- [Mac-Setup](https://github.com/MorganKryze/mac-setup)
### Documentation
- [General utility packages](./docs/tools/general.md)
- [Dev packages](./docs/tools/dev.md)
### Prerequisites
- macOS recent version
- Terminal.app
### Install
To install the dotfiles, you can follow the steps below:
1. Clone the repository:
```bash
cd ~
git clone [email protected]:MorganKryze/.dotfiles.git
```
Or download the repository as a zip file and extract it.
2. Run the installation script:
```bash
cd .dotfiles
./bootstrap.sh
```
3. Update the `.env.example` file with your personal information and rename it to `.env`. (Optional: remove it if you do not need these variables)
4. Restart your computer.
5. Enjoy!
## Supported platform
- macOS
## Roadmap
- [ ] document the brew packages (similar to [Mac-Setup](https://github.com/MorganKryze/mac-setup))
- [ ] document and improve [Easy-Git](https://github.com/MorganKryze/easy-git) work
- [ ] document and improve [Easy-Env](https://github.com/MorganKryze/easy-env) work
- [ ] document and improve [Yabai-Setup](https://github.com/MorganKryze/yabai-setup) work
## Acknowledgments
The acknowledgments are described in the [ACKNOWLEDGMENTS](./.github/ACKNOLEDGMENTS.md) file.
## Contributing
If you want to contribute to the project, you can follow the steps described in the [CONTRIBUTING](./.github/CONTRIBUTING.md) file.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.