summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 5155873d597b3acd71f9783ca2a740a17147176f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<p align="center">
     <img src="./assets/header.png">
<p align="center">
    Easy-to-use CUI for fixing git conflicts
    <br>
    <br>
  </p>
</p>
<br>

I never really liked any of the `mergetools` out there so I made a simple program that does simple things… in a simple fashion.

![](./assets/overview.png)

## 👷 Installation

Execute:

```bash
$ go get github.com/mkchoi212/fac
```

Or using [Homebrew 🍺](https://brew.sh)

```bash
brew tap mkchoi212/fac https://github.com/mkchoi212/fac.git
```

## Using

`fac` operates much like `git add -p` . It has a prompt input at the bottom of the screen where the user inputs various commands.

The commands have been preset to the following specifications

```
w - show more lines up
s - show more lines down
a - select left screen
d - select right screen

j - scroll down
k - scroll up

v - [v]iew orientation 
n - [n]ext conflict
p - [p]revious conflict 

h | ? - [h]elp
q | Ctrl+c - [q]uit

[wasd] >> [INPUT HERE]
```



> The movement controls have been derived from both the world of gamers (WASD) and VIM users (HJKL). 

## ✋ Contributing

This is an open source project so feel free to contribute by

- Opening an [issue](https://github.com/mkchoi212/fac/issues/new)
- Sending me feedback via [email](mailto://mkchoi212@icloud.com)
- Or [tweet](https://twitter.com/Bananamlkshake2) at me!

## 👮 License
See [License](./LICENSE)