summaryrefslogtreecommitdiff
path: root/README.org
blob: 819324b25d97333c636008f5598f2ac6a8198039 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
#+title: Dotfiles | My Linux setup
#+OPTIONS: num:nil toc:nil
* Table of contents :TOC:
- [[#about][About]]
- [[#configurations][Configurations]]
- [[#installation][Installation]]
- [[#warning][WARNING!]]

* 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 [[https://www.gnu.org/software/stow/][GNU Stow]], which allows me to easily manage and switch between different configurations for different systems or environments.
  
* Configurations
+ [[file:emacs.org][Emacs]]
+ [[file:shells.org][Shells]]
+ [[file:Qtile.org][Qtile]]
    
/Qtile with emacs/
 [[file:pictures/showcase2.png]]
* Installation
+ clone repository

#+begin_src bash
  git clone https://github.com/ThanosApollo/dotfiles.git ~/dotfiles
#+end_src
+ Install [[https://www.gnu.org/software/stow/][GNU stow]]
  
#+begin_src bash
  guix install stow  # use the package manager of your distro if not guix
#+end_src
+ Use stow
#+begin_src bash
  cd ~/dotfiles
  stow . 
#+end_src
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.