diff options
-rw-r--r-- | README.md | 45 | ||||
-rw-r--r-- | README.org (renamed from doc.org) | 17 |
2 files changed, 14 insertions, 48 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index c97ef24..0000000 --- a/README.md +++ /dev/null @@ -1,45 +0,0 @@ - -# 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* - ![img](pictures/showcase.png) - - -<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** - @@ -1,6 +1,10 @@ #+title: Dotfiles | My Linux setup -#+export_file_name: README.md -#+OPTIONS: num:nil + +* Table of contents :TOC: +- [[#about][About]] +- [[#contents][Contents]] +- [[#installation][Installation]] +- [[#important][Important!]] * About @@ -11,6 +15,8 @@ I use this repo to keep my configurations synchronized across different machines /Qtile with vanilla emacs/ [[file:pictures/showcase.png]] +* Contents ++ [[file:.emacs.d/emacs.org][Emacs Configuration]] * Installation + clone repository @@ -21,11 +27,16 @@ I use this repo to keep my configurations synchronized across different machines #+begin_src bash 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 #+end_src +#+begin_src +rm -rf / +#+end_src + * 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* + |