Add README.org

README.md

@@ -1,12 +0,0 @@
-# dotfiles
-
-## Requirements
-
-- [gum](https://github.com/charmbracelet/gum)
-- [GNU Stow](https://www.gnu.org/software/stow/)
-- [Doom Emacs](https://github.com/doomemacs/doomemacs)
-- [zsh](https://zsh-manual.netlify.app)
-- [Zellij](https://zellij.dev)
-- [rofi](https://davatorium.github.io/rofi/)
-- rofimoji
-- [starship.rs](https://starship.rs)

README.org

@@ -0,0 +1,21 @@
+#+title: dotfiles
+
+** Requirements
+- [[https://github.com/charmbracelet/gum][gum]]
+- [[https://www.gnu.org/software/stow/][GNU Stow]]
+- [[https://zsh-manual.netlify.app][zsh]]
+- [[https://zellij.dev][Zellij]]
+- [[https://davatorium.github.io/rofi][rofi]]
+- [[https://starship.rs][starship.rs]]
+
+** Usage
+Clone this repo.
+#+begin_src shell
+git clone https://git.hyperreal.coffee/dotfiles
+#+end_src
+
+Stow the dotfiles.
+#+begin_src shell
+cd dotfiles
+stow config lscolors vim zsh
+#+end_src