From: sabadev <saba@sabadev.xyz>
Date: Mon, 12 Jul 2021 00:49:51 +0000 (-0400)
Subject: Added a README file.
X-Git-Url: http://sabadev.xyz:4321/?a=commitdiff_plain;h=refs%2Fheads%2Fmain;p=git-skipper.git

Added a README file.
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ef2351
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# git-skipper
+
+## Usage
+
+This program is designed to make it easier to work with `git update-index --skip-worktree` for multiple files.
+
+Assuming `git-skipper` is in your PATH, try adding the following aliases to your global git configuration (`git config --global -e`) for easy access through git:
+
+    [alias]
+      skip = !git-skipper -i
+      skip-all = !git-skipper -m
+      unskip-all = !git-skipper -p
+      skip-one = !git-skipper -s
+      unskip-one = !git-skipper -n
+      skip-list = !git-skipper -l
+
+This allows you to access `git-skipper` using commands such as `git skip` or `git skip-one path/to/file`.
+
+Run `git-skipper -h` to view the available flags.
+Running `git-skipper` with no flags will result in nothing occurring.
+
+## Compilation
+
+To compile this program, you will first need to install Racket 8.1 or above.
+This can be done on Windows through Chocolatey using `choco install racket`.
+Next, run `raco exe git-skipper.rkt` to compile a new executable.
+Use `raco exe --embed-dlls git-skipper.rkt` to compile a standalone executable for distribution to systems without a Racket installation.