From c9e142b8b97a84e6ffdab84cd89922a59176ddad Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Thu, 7 Jul 2016 23:27:49 +0000 Subject: add README.org --- README.org | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.org (limited to 'README.org') diff --git a/README.org b/README.org new file mode 100644 index 0000000..7d5f17b --- /dev/null +++ b/README.org @@ -0,0 +1,38 @@ +* git difme + +stages files and makes commits on a list of git repositories based on +some rules. + +** rules + +the rules specify what type of files to stage. + +file types: + + - untracked file (??). + - modified file (M). + - deleted file (D). + - renamed file (R). + - copied file (C). + +the rules are defined per git repository in the config file. + +** config + +the config file must be at =~/.config/git-difme/config=. + +the config is simply a scheme file that defiens =difm-repos=: + +#+BEGIN_SRC scheme +(define difm-repos (list + (cons '/path/to/git/repo/foo '(M D)) + (cons '/path/to/git/repo/bar '(R M)) + (cons '/path/to/git/repo/baz '(C M ??)))) +#+END_SRC + +- for repo ~foo~, git difm will only stage modified (M) and + deleted (D) files. +- for repo ~bar~, git difm will only stage renamed (R) and modified + (M) files. +- for repo ~baz~, git difm will only stage copied (C), modified (M) + and untracked files. -- cgit v1.2.3