Awesome Open Source
Awesome Open Source

.config

Properly managed, easy-to-grok dotfiles for macOS and Ubuntu.

Enjoy using this software? Become a sponsor!

screenshot

Installation

  1. Open a terminal, do one of the folowing, and wait for the installation to complete:
    • macOS:
      xcode-select --install
      
    • Ubuntu:
      sudo apt install zsh
      
  2. Fork this repo.
  3. In your fork, edit git/.gitconfig (you can do this through GitHub's web UI) to make Git use your name and email address, not mine!
  4. Open a terminal and do the following:
    % cd ~
    % mv .config .config~   # Back up your old .config dir (if any).
    % # Clone your fork, which will make a new .config dir:
    % git clone https://github.com/<YOUR USER NAME>/.config.git
    ...
    % cd .config            # Go to your new .config dir.
     Add anything you want to keep from your old dotfiles.
    % make -j install       # Run the installer to deploy your new dotfiles.
    ...
    % # Finally, update your fork with your changes:
    % git add -f <file> ... # All files have to be staged explicitly.
    % git commit
    % git push
    ...
    %
    
  5. Restart your terminal.

Getting Updates

To get new updates to your fork from my repo, do the following:

% cd ~/.config
% make -jr              # Pull in updates from upstream (my repo), but don't install them yet.
...
 Review the incoming changes and make any adjustments you like.
% make -jr install      # Run the installer to deploy your changes.
...
% # Finally, update your fork with your changes:
% git add -f <file>...  # Choose which files you actually want to track in Git.
% git commit
% git push
...
%

Author

2020-2021 Marlon Richert

License

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


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Shell (229,160
Linux (17,038
Macos (9,186
Git (7,649
Dotfiles (6,729
Terminal (4,252
Ubuntu (3,407
Zsh (3,363
Ssh (2,266
Unix (1,624
Osx (1,514
Mac (1,462
Homebrew (1,424
Gnome (765
Configuration Files (448
Brew (252
Terminal App (227
Karabiner Elements (33
Related Projects