Metadata-Version: 1.1
Name: dotstow
Version: 0.1.3
Summary: Manage dotfiles with stow
Home-page: https://github.com/codejamninja/dotstow
Author: Jam Risser
Author-email: jam@codejam.ninja
License: MIT
Description: dotstow
        =======
        
        `GitHub stars <https://github.com/codejamninja/dotstow>`__
        
           Manage dotfiles with stow
        
        Please ★ this repo if you found it useful ★ ★ ★
        
        Features
        --------
        
        -  Group dotfiles into units (stow packages)
        -  Automatically symlink (stow) files
        -  Backup dotfiles with git
        -  Powered by `GNU Stow <https://www.gnu.org/software/stow/>`__
        
        Installation
        ------------
        
        .. code:: sh
        
           pip3 install dotstow
        
        Dependencies
        ------------
        
        -  `Python 3 <https://www.python.org>`__
        -  `GNU Stow <https://www.gnu.org/software/stow>`__
        
        Usage
        -----
        
        Note that unlike many dotfile syncing tools, this is powered by `GNU
        Stow <https://www.gnu.org/software/stow>`__. This means your dotfiles
        must be stored inside stow packages (subfolders) instead of the root of
        your repo. This prevents cluttering your home directory with unwanted
        files, like your ``README.md``. It also enables you to only install
        dotfiles you want on that computer.
        
        Setup
        ~~~~~
        
        Create a remote dotfiles repo. You can create one at
        `GitHub <https://github.com/new>`__.
        
        Run the following command
        
        .. code:: sh
        
           dotstow sync
        
        Creating a stow package
        ~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: sh
        
           mkdir ~/.dotfiles/my-stow-package
        
        Adding dotfiles to stow package
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: sh
        
           mv ~/.some-dotfile ~/.dotfiles/my-stow-package
        
        Symlink stow package
        ~~~~~~~~~~~~~~~~~~~~
        
        Note that this will fail if conflicting files exist in the home
        directory.
        
        .. code:: sh
        
           dotstow my-stow-package
        
        Syncing dotfiles
        ~~~~~~~~~~~~~~~~
        
        .. code:: sh
        
           dotstow sync
        
        Example
        ~~~~~~~
        
        The following example demonstrates syncing your ``.zshrc`` file with
        dotstow
        
        .. code:: sh
        
           mkdir ~/.dotstow/zsh       # creates a new stow package called 'zsh'
           mv ~/.zshrc ~/.dotstow/zsh # adds dotfiles to the 'zsh' stow package
           dotstow zsh                # symlinks the 'zsh' stow package
           dotstow sync               # syncs your dotfiles
        
        Support
        -------
        
        Submit an `issue <https://github.com/codejamninja/dotstow/issues/new>`__
        
        Contributing
        ------------
        
        Review the `guidelines for
        contributing <https://github.com/codejamninja/dotstow/blob/master/CONTRIBUTING.md>`__
        
        License
        -------
        
        `MIT
        License <https://github.com/codejamninja/dotstow/blob/master/LICENSE>`__
        
        `Jam Risser <https://codejam.ninja>`__ © 2018
        
        Changelog
        ---------
        
        Review the
        `changelog <https://github.com/codejamninja/dotstow/blob/master/CHANGELOG.md>`__
        
        Credits
        -------
        
        -  `Jam Risser <https://codejam.ninja>`__ - Author
        
        Support on Liberapay
        --------------------
        
        A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of
        building this project.
        
        `Add some fuel <https://liberapay.com/codejamninja/donate>`__ if you’d
        like to keep me going!
        
        `Liberapay receiving <https://liberapay.com/codejamninja/donate>`__
        `Liberapay patrons <https://liberapay.com/codejamninja/donate>`__
        
Keywords: ubuntu remaster fork install linux
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
