From 5ad60096c4980f0910a667afa5c5ff685cc1cce2 Mon Sep 17 00:00:00 2001 From: Thanos Apollo Date: Fri, 10 Feb 2023 05:23:29 +0200 Subject: update readme --- README.md | 45 --------------------------------------------- README.org | 42 ++++++++++++++++++++++++++++++++++++++++++ doc.org | 31 ------------------------------- 3 files changed, 42 insertions(+), 76 deletions(-) delete mode 100644 README.md create mode 100644 README.org delete mode 100644 doc.org 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) - - - - - -# 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) - - - - -# 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 -``` - - - -# 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** - diff --git a/README.org b/README.org new file mode 100644 index 0000000..ffb33f9 --- /dev/null +++ b/README.org @@ -0,0 +1,42 @@ +#+title: Dotfiles | My Linux setup + +* Table of contents :TOC: +- [[#about][About]] +- [[#contents][Contents]] +- [[#installation][Installation]] +- [[#important][Important!]] + +* 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/ + [[file:pictures/showcase.png]] + +* Contents ++ [[file:.emacs.d/emacs.org][Emacs Configuration]] +* 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 + + 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* + + diff --git a/doc.org b/doc.org deleted file mode 100644 index 9b88813..0000000 --- a/doc.org +++ /dev/null @@ -1,31 +0,0 @@ -#+title: Dotfiles | My Linux setup -#+export_file_name: README.md -#+OPTIONS: num:nil - -* 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/ - [[file:pictures/showcase.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 - - cd ~/dotfiles - stow . # if you get errors, rename your files that produce them, e.g mv ~/.bashrc ~/.bashrc_backup -#+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* - -- cgit v1.2.3