diff options
| author | Azat Bahawi <azahi@teknik.io> | 2020-01-12 18:29:24 +0300 |
|---|---|---|
| committer | Azat Bahawi <azahi@teknik.io> | 2020-01-12 18:29:24 +0300 |
| commit | f1481861857a14a024b990954cf4a0f655035dc0 (patch) | |
| tree | a804171a8e1b17218fd7b88804be86fb6166518d | |
| parent | Minor fixes to keybinds and scripts (diff) | |
Add readme.org
| -rw-r--r-- | readme.org | 36 |
1 files changed, 35 insertions, 1 deletions
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. |