From f1481861857a14a024b990954cf4a0f655035dc0 Mon Sep 17 00:00:00 2001
From: Azat Bahawi <azahi@teknik.io>
Date: Sun, 12 Jan 2020 18:29:24 +0300
Subject: Add readme.org

---
 readme.org | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

(limited to 'readme.org')

diff --git a/readme.org b/readme.org
index e51f235..0483233 100644
--- a/readme.org
+++ b/readme.org
@@ -1 +1,35 @@
-* azahi's XMonad configuration (xmonad-ng)
+* XMonad
+XMonad configuration formerly known as "xmonad-ng".
+
+** Example Installation
+Clone this repository with submodules in the root of your home directory:
+#+BEGIN_SRC bash
+git clone --recursive https://github.com/azahi/xmonad-config ~/.xmonad
+#+END_SRC
+
+Enter the cloned directory:
+#+BEGIN_SRC bash
+cd ~/.xmonad
+#+END_SRC
+
+If you don't have a /xmonad/ executable in your PATH, depending on the build
+system that you want to use, execute:
+#+BEGIN_SRC bash
+stack update
+stack build
+#+END_SRC
+or
+#+BEGIN_SRC bash
+cabal new-update
+cabal new-configure
+cabal new-build
+#+END_SRC
+
+If you have the /xmonad/ executable you can just simply run:
+#+BEGIN_SRC bash
+xmonad --recompile
+#+END_SRC
+
+** Copyright
+All of the source code including vendored xmonad, xmonad-contrib and xmobar packages
+are released under BSD 3-Clause license.
-- 
cgit 1.4.1