summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore3
-rw-r--r--README.md28
2 files changed, 10 insertions, 21 deletions
diff --git a/.gitignore b/.gitignore
index 552c503..9b75aa8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
exec.go.test
+build.sh
test.go
-.vscode \ No newline at end of file
+.vscode
diff --git a/README.md b/README.md
index 7e6f592..12f4cb8 100644
--- a/README.md
+++ b/README.md
@@ -1,44 +1,32 @@
[![Build Status](https://travis-ci.com/isacikgoz/gitbatch.svg?branch=master)](https://travis-ci.com/isacikgoz/gitbatch) [![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/isacikgoz/gitbatch)](https://goreportcard.com/report/github.com/isacikgoz/gitbatch)
## gitbatch
-This tool is beening built to make your local repositories synchronized with remotes easily. Although the focus is batch jobs, you can still do de facto micro management of your git repositories (e.g *add/reset, stash, commit etc.*)
+This tool is being built to make your local repositories synchronized with remotes easily. Although the focus is batch jobs, you can still do de facto micro management of your git repositories (e.g *add/reset, stash, commit etc.*)
Here is the screencast of the app:
[![asciicast](https://asciinema.org/a/QQPVDWVxUR3bvJhIZY3c4PTuG.svg)](https://asciinema.org/a/QQPVDWVxUR3bvJhIZY3c4PTuG)
## Installation
-For now, installation requires golang compiler and minimum golang 1.10 is recommended. (binary distribution will be provided on minimum viable product)
-- If you don't have golang installed refer to [golang.org](https://golang.org/dl/).
-- You should have $GOPATH env variable set and your $PATH should include $GOPATH/bin to run app from anywhere.
-
-To install run the following command;
+To install with go, run the following command;
```bash
go get -u github.com/isacikgoz/gitbatch
```
-I prefer using gopath like this in my zshrc or bashrc;
-```bash
-export GOPATH=$HOME/go
-export PATH=$PATH:$GOPATH/bin
-```
+For other options see [installation page](https://github.com/isacikgoz/gitbatch/wiki/Installation)
## Use
run the `gitbatch` command from the parent of your git repositories. For start-up options simply `gitbatch --help`
-For more information;
-- To see keybindings refer to [Controls page](https://github.com/isacikgoz/gitbatch/wiki/Controls)
-- Learn how to config app at [Configuration page](https://github.com/isacikgoz/gitbatch/wiki/Configuration)
-- Wonder what mode does what? see [Modes page](https://github.com/isacikgoz/gitbatch/wiki/Modes)
-- What are those arrows, colors etc mean? Answer is here at [Display page](https://github.com/isacikgoz/gitbatch/wiki/Display)
+For more information see the [wiki pages](https://github.com/isacikgoz/gitbatch/wiki)
## Further goals
- add testing
-- full src-d/go-git integration (*having some performance issues*)
- - fetch, config, add, reset, commit, status, diff ✔
- - merge, rev-list, stash ✗
- add push
+- full src-d/go-git integration (*having some performance issues in such cases*)
+ - fetch, config, add, reset, commit, status and diff commands are supported but not fully utilized, still using git sometimes
+ - merge, rev-list, stash are not supported yet by go-git
## Known issues
-Please refer to [Known issues page](https://github.com/isacikgoz/gitbatch/wiki/Known-issues)
+Please refer to [Known issues page](https://github.com/isacikgoz/gitbatch/wiki/Known-issues) and feel free to open an issue if you encounter with a problem.
## Credits
- [go-git](https://github.com/src-d/go-git) for git interface (partially)