From e0427e88ef9b20e5445178154ff6fd7f3ea3e40b Mon Sep 17 00:00:00 2001 From: s2 Date: Sat, 19 May 2018 22:48:58 +0200 Subject: [PATCH] readme --- README.md | 20 ++++++++++++++++++++ {screenshot => screenshots}/main.png | Bin 2 files changed, 20 insertions(+) create mode 100644 README.md rename {screenshot => screenshots}/main.png (100%) diff --git a/README.md b/README.md new file mode 100644 index 00000000..fdb7a45c --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# gitlit + +gitlit is a very simple desktop app that allows you to handle [git lfs file locks](https://github.com/git-lfs/git-lfs/wiki/File-Locking). + +![gitlit main window](screenshots/main.png) + +## download + +Just go to releases and download the version for your platform. + +## usage + +gitlit takes one command line argument: the git repository directory on your filesystem you want to handle the locks for. + +So if you want to look at the locked files on the `/home/s2/myApp` directory, run gitlit like this: +``` +gitlit /home/s2/myApp +``` + +If no folder is specified, gitlit looks at the current path. diff --git a/screenshot/main.png b/screenshots/main.png similarity index 100% rename from screenshot/main.png rename to screenshots/main.png