diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..d375486 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ + +# Table of Contents + +- [About](#org40feefd) +- [Installation](#org4836c36) +- [Important!](#org4461b5b) + + + +<a id="org40feefd"></a> + +# About + +Personal dotfiles, managed with GNU stow + +I use this repo to keep my configurations synchronized across different machines. Including a macOS laptop. + +*Qtile with vanilla emacs* +  + + +<a id="org4836c36"></a> + +# Installation + +- clone repository +``` + git clone https://github.com/ThanosApollo/dotfiles.git ~/dotfiles +``` + +- Install [GNU stow](https://www.gnu.org/software/stow/) +``` + guix install stow # use the package manager of your distro if not guix + + cd ~/dotfiles + stow . # if you get errors, rename your files that produce them, e.g mv ~/.bashrc ~/.bashrc_backup +``` + +<a id="org4461b5b"></a> + +# Important! + +**I do not recommend to run my dotfiles as is. Proceed with caution, you are better off copying parts of my code and implementing them in your own configuration** + |