diff options
| -rw-r--r-- | README.md | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index 6f57bd0..0000000 --- a/README.md +++ /dev/null @@ -1,61 +0,0 @@ - -# Table of Contents - -- [About](#org7568426) -- [Configurations](#org4c3c935) -- [Installation](#orgef89a19) -- [WARNING!](#org972d53a) - - - -<a id="org7568426"></a> - -# About - -Welcome to my dotfiles repository! - -Here you will find my custom configuration files for a variety of applications and utilities. All of which are written in org-mode literate configuration format. - -All of the configurations in this repository are managed using [GNU Stow](https://www.gnu.org/software/stow/), which allows me to easily manage and switch between different configurations for different systems or environments. - - -<a id="org4c3c935"></a> - -# Configurations - -- [Emacs](emacs.md) -- [Shells](shells.md) -- [Qtile](Qtile.md) - -*Qtile with emacs* -  - - -<a id="orgef89a19"></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 - -- Use stow - - cd ~/dotfiles - stow . - -If you get any errors due to existing files, rename them with `_backup` at the end - -e.g `mv ~/.bashrc ~/.bashrc_backup` - - -<a id="org972d53a"></a> - -# WARNING! - -It's important to note that my dotfiles in this repository are constantly evolving, as I am constantly experimenting with new configurations and settings. While I am happy to share my configurations, **I do not recommend using them as-is on your own system** without careful review and testing. It's possible that some configurations may not work as expected or may cause issues on your system. Therefore, I strongly recommend taking caution and reviewing any changes carefully before applying them to your own system. - |