From 1a260093ab9214a5a5ebd0703afdb6668c9c4d3b Mon Sep 17 00:00:00 2001
From: Julian T <julian@jtle.dk>
Date: Wed, 18 Aug 2021 18:22:16 +0200
Subject: Update readme

---
 README.md  | 44 ++++++++++++++++++++++++++++++++++++++++++++
 README.org | 28 ----------------------------
 2 files changed, 44 insertions(+), 28 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.org

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8b0b13c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# newDotFiles
+
+This is where i keep my dotfiles and scripts.
+
+## Dotfile Management
+
+Dotfiles are stored in modules which map to the home directory.
+For example does the file `vim-core/.vim/vimrc` map to the file `~/.vim/vimrc`, where `vim-core` is the module.
+This means that different configurations can be selectively added.
+
+Modules are applied with the included `apply` python module.
+To apply the two vim modules run:
+
+```bash
+python -m apply apply vim-core vim-extra
+```
+
+If changes have been made to modules, they can be reapplied with:
+
+```bash
+python -m apply apply -a
+```
+
+File ownership status can be queried with:
+
+```bash
+python -m apply status
+```
+
+## Ignored Folders
+
+The file `config.yaml` specifies the directories which must not be linked.
+These are directories such as `~/.config` or `~` itself.
+
+## Stored State
+
+State and ownership of files in the home directory are saved in the `state_*.json` files.
+A hash has been added to enable multiple target directies, without them interfering.
+
+## Bugs and Missing Features in apply
+
+- [ ] Clean up unused files
+- [ ] Do not crash on `python -m apply remove`
+- [ ] Make launching apply software easier
diff --git a/README.org b/README.org
deleted file mode 100644
index 731db65..0000000
--- a/README.org
+++ /dev/null
@@ -1,28 +0,0 @@
-* newDotFiles
-
-  This is where i keep my dotfiles and scripts.
-
-** Dotfile management
-
-   I use [[https://www.gnu.org/software/stow/][GNU Stow]] for dot file management. This splits the dotfiles into multiple modules, 
-   for example can zsh be installed without installing dwm.
-
-   To install a package or module one can run.
-
-   : stow emacs
-
-** Stows script
-
-	This scripts runs pre and post setup scripts. 
-
-	These scripts are in encased in # because it's in stow's default ignore :-D. 
-
-	To use the wrapper script run.
-
-	: stows emacs
-
-	To pass flags to package scripts put them before the package
-
-	: stows vim -D emacs
-
-	This will setup vim and delete emacs.
-- 
cgit v1.2.3