cdotfis-mac/README.md

1.8 KiB

dotfiles

Personal dotfiles saved and deployed using sadedot.

Table of contents

Installation

Fork this repository.

Usage

You have to move all your dotfiles to the dotfiles folder and then the sadedot scripts will do the symbolic links. Doing it this way, you can now upload them to your repository (to have a backup of them).

You should note that all these dotfiles (files or folders) will be symlinked in $HOME. So, if you want to symlink, for example, something in /etc, you have to put it in the dotfiles/other folder. Here you have to be careful as they will be installed in /. You can see an example here.

So, to run the script:

sh sadedot/scripts/bootstrap.sh

You can modify the sadedot/scripts/install.sh if you want to install some programs on your machine when this script is run. By default, sadedot/scripts/bootstrap.sh will not run this script, so you will need to use the -p flag if you want it to run sadedot/scripts/install.sh (it will run at the end of the script).

Updating

To keep your fork up to date with additions to the sadedot submodule, you must run:

sh sadedot/scripts/update.sh

Contributing

PRs are welcome.

License

MIT