diff options
| -rw-r--r-- | README.md | 58 | ||||
| -rwxr-xr-x | README.org | 14 |
2 files changed, 65 insertions, 7 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..264f2f3 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ + + +# 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. + +- Hosted at [sourcehut](https://git.sr.ht/~thanos_apollo/dotfiles) + + +# Configurations + +- [Emacs](emacs.md) +- [Shells](shells.md) +- [Qtile](Qtile.md) + +*Qtile with emacs* +  + +Themes I'm using: + +- [Dracula for rofi](https://github.com/dracula/rofi) +- [Dracula for nyxt](https://github.com/dracula/nyxt) +- [Dracula for Qutebrowser](https://github.com/dracula/qutebrowser) +- [mocp-themes](https://github.com/wimstefan/mocp-themes) collection + + +# 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` + + +# 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. + @@ -1,12 +1,6 @@ #+title: Dotfiles | My Linux setup #+OPTIONS: num:nil toc:nil #+STARTUP: overview -* Table of contents :TOC: -- [[#about][About]] -- [[#configurations][Configurations]] -- [[#installation][Installation]] -- [[#warning][WARNING!]] - * About Welcome to my dotfiles repository! @@ -14,6 +8,8 @@ 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 [[https://www.gnu.org/software/stow/][GNU Stow]], which allows me to easily manage and switch between different configurations for different systems or environments. + +- Hosted at [[https://git.sr.ht/~thanos_apollo/dotfiles][sourcehut]] * Configurations + [[file:emacs.org][Emacs]] @@ -49,6 +45,10 @@ If you get any errors due to existing files, rename them with ~_backup~ at the e e.g ~mv ~/.bashrc ~/.bashrc_backup~ * 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. +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. |