summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2023-02-08 01:27:30 +0200
committerThanos Apollo <[email protected]>2023-02-08 01:27:30 +0200
commit25392d6474d4b27ab04a9ac4f2358f85fdd86c25 (patch)
tree7fb27f6bbdca0e1715b53410221d52a90b918b45
parent8cb0c916e82fd27231ac31325f1f7aeb493a4b63 (diff)
Rename org file to doc
-rw-r--r--README.org15
-rw-r--r--doc.org29
2 files changed, 29 insertions, 15 deletions
diff --git a/README.org b/README.org
deleted file mode 100644
index c60741a..0000000
--- a/README.org
+++ /dev/null
@@ -1,15 +0,0 @@
-#+title: Dotfiles | My Linux setup
-
-* 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/
- [[pictures/showcase.png]]
-
-
-* 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
new file mode 100644
index 0000000..ef97e82
--- /dev/null
+++ b/doc.org
@@ -0,0 +1,29 @@
+#+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 sh
+ git clone https://github.com/ThanosApollo/dotfiles.git ~/dotfiles
+#+end_src
++ Install [[https://www.gnu.org/software/stow/][GNU stow]]
+#+begin_src sh
+ 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*
+