📚docs: add project README

1 files changed, 57 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..83fa0ec
--- /dev/null
+++ b/README.org
@@ -0,0 +1,57 @@
+#+TITLE: My Public Dotfiles
+#+AUTHOR: Naz <ndpm13@ch-naseem.com>
+#+STARTUP: showeverything
+#+OPTIONS: toc:nil
+
+This repository contains a bunch of configuration files. Take a look around, you
+might find something useful!
+
+* Usage
+
+1. Back up your current configurations.
+2. Clone this repository somewhere in your system
+   #+begin_src sh
+git clone --depth 1 https://git.ch-naseem.com/ndpm13/dotfiles.git
+   #+end_src
+3. Make sure you're inside the ~dotfiles~ directory before using ~stow~
+   #+begin_src sh
+stow <package> --adopt
+   #+end_src
+
+* Packages
+
+These are all the packages included in this repository, I'll try to list the
+required dependencies for each package.
+
+** shells (ZSH, Bash)
+
+*** Dependencies
+
+- ~zoxide~
+- ~eza~
+- ~doas~
+- ~zsh-syntax-highlighting~
+- ~zsh-completions~
+- ~bash-completion~
+- Neovim (optional)
+- VSCodium (optional)
+- ~wget~ (optional)
+- ~sudo~ (optional)
+- ~xbps~ (optional)
+- ~cargo-update~ (optional)
+- ~mpv~ (optional)
+- ~yt-dlp~ (optional)
+- ~lf~ (optional)
+- ~starship~ (optional)
+- ~fzf~ (optional)
+
+** nvim
+
+Main repository can be found at [[https://git.ch-naseem.com/ndpm13/nvim-config][ndpm13/nvim-config]].
+
+*** Dependencies
+
+- ~git~
+- ~gcc~
+- Nerd Font (optional)
+- ~silicon~ (optional)