diff --git a/README.md b/README.md new file mode 100644 index 0000000..ed59cb1 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# dotfiles + +## Requirements + +* [gum](https://github.com/charmbracelet/gum) +* GNU Stow +* Zsh +* [Zellij](https://zellij.dev) +* rofi +* [starship](https://starship.rs) + +## Usage + +Clone this repo. + + git clone https://git.hyperreal.coffee/dotfiles + +Stow the dotfiles. + + cd dotfiles + stow config lscolors vim zsh + diff --git a/README.org b/README.org deleted file mode 100644 index a0df2e7..0000000 --- a/README.org +++ /dev/null @@ -1,21 +0,0 @@ -#+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