Metadata-Version: 2.1
Name: mydot
Version: 0.1.3
Summary: Manage and edit $HOME dotfiles using Python + git = <3
Home-page: https://github.com/gikeymarcia/mydot
Author: Mikey Garcia
Author-email: gikeymarcia@gmail.com
License: GPL-3.0
Description: # mydot -- A Python Module for managing dotfiles
        
        ## Quick Start
        
        1. Configure `bash`
        
            ```bash
            # add to the bottom of your `~/.bashrc`:
            export DOTFILES="$HOME/.config/dotfiles"
            alias config="/usr/bin/git --git-dir=$DOTFILES --work-tree=$HOME"
            alias d.="python -m mydot"
            ```
        
            First we define a variable which will point to where our dotfiles are stored then making two aliaes. The first alias is to interact with the repo directly and the other is for invoking `mydot`.
        
        2. Initialize dotfiles repository
        
            ```bash
            mkdir -pv $DOTFILES
            git init --bare $DOTFILES
            ```
        
            Create the directory (and any parents) then initialize the bare repo
        
        3. Confirm and configure dotfiles repo
        
            ```bash
            # Confirm working dotfiles alias
            config status
            # Disable display of untracked files
            config config --local status.showUntrackedFiles no
            # Confirm change
            config status
            # Add files to track using Git
            config add -v ~/.vimrc ~/.tmux.conf ~/.bashrc ~/.bash_aliases
            ```
        
        4. Get powerful with `mydot`
        
            ```bash
            python -m pip install --user mydot
            d. --edit
            d. --help
            d. --status
            d. --add
            ```
        
        ### Source of Truth
        
        This project is available on [GitHub][github] and [GitLab][gitlab]. Each push to 
        `master` automatically goes to both so choose whichever platform you prefer.
        
        [github]: <https://github.com/gikeymarcia/mydot>
        "Follow and Contribute on GitHub"
        [gitlab]: <https://gitlab.com/gikeymarcia/mydot>
        "Follow and Contribute on GitLab"
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
