cdotfis/README.md

1.9 KiB

dotfiles

Personal dotfiles saved and deployed using sadedot.

Table of contents

Installation

Fork this repository and clone it running:

git clone --recursive ${REPO_URL}

where ${REPO_URL} is your github repository remote url (HTTPS or SSH). For example, in my case:

git clone --recursive git@github.com:santilococo/cdotfis.git

Usage

You have to move all your dotfiles to the dotfiles folder and then a sadedot script 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).

Contributing

PRs are welcome.

License

MIT