Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(users): add information on how to run the flatpak and how to use … #230

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc(users): add information on how to run the flatpak and how to use … #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 26 additions & 7 deletions docs/users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,31 @@

### Using Flatpak

```sh
flatpak install io.github.mightycreak.Diffuse
```

Flatpak is probably the easiest way to install Diffuse on any distribution and
get the latest and greatest as quickly as possible. The Flatpak package is
hosted on [Flathub](https://flathub.org).

_Note:_ If the Flathub repository is not installed yet, please follow
[these instructions](https://flatpak.org/setup/).

Install diffuse using

```sh
flatpak install io.github.mightycreak.Diffuse
```

then run it either from you application menu or via command line

```sh
flatpak run io.github.mightycreak.Diffuse
```

To open files for comparison from your shell run

```sh
flatpak run --file-forwarding io.github.mightycreak.Diffuse file1 file2
```

### Using the distribution package manager

The Diffuse package statuses for every distributions can been seen on
Expand All @@ -25,9 +39,14 @@ Diffuse package on Fedora.

## Integrate with Git

Diffuse is compatible with `git difftool` command-line. To use Diffuse as Git
diff tool, run:
Diffuse is compatible with `git difftool` and `git mergetool` command-line. To use Diffuse as Git
diff/merge tool, run:

```sh
git config --global diff.tool diffuse
git config --global difftool.diffuse_flatpak.cmd 'flatpak run --file-forwarding --filesystem=/tmp io.github.mightycreak.Diffuse $LOCAL $REMOTE'
git config --global diff.tool diffuse_flatpak
```
```sh
git config --global mergetool.diffuse_flatpak.cmd 'flatpak run --file-forwarding --filesystem=/tmp io.github.mightycreak.Diffuse $BASE $LOCAL $MERGED $REMOTE'
git config --global merge.tool diffuse_flatpak
```