Skip to content

recover old User doc and move installation to readme #226

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
58 changes: 51 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,55 @@
# Diffuse documentation

Welcome to Diffuse documentation!
**Diffuse** is a small and simple text merge tool written in Python.

Here are the main sections:
With Diffuse, you can easily merge, edit, and review changes to your code.

- [Quick Start](#quick-start)
- [Users](users.md)
- [Translators](translators.md)
- Developers
- [Developers setup](developers/developers-setup.md)
- [Release process](developers/release-process.md)

## Installation

### 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/).

### Using the distribution package manager

The Diffuse package statuses for every distributions can been seen on
[repology](https://repology.org/project/diffuse/versions).

Huge thanks to [@bongochong](https://github.com/bongochong) for maintaining the
Diffuse package on Fedora.

## Integrate with Git

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

```sh
git config --global diff.tool diffuse
```

## Quick Start
Compare a Set of Files
<pre>$ diffuse <em>file1</em> <em>file2</em> <em>file3</em></pre>
Review Local Changes or Fix Merge Conflicts
<pre>$ diffuse -m</pre>
Compare Specific Revisions
<pre>$ diffuse -r <em>rev1</em> -r <em>rev2</em> <em>file</em></pre>
Inspect a Revision
<pre>$ diffuse -c <em>rev</em></pre>

1. [Users](users.md)
2. [Translators](translators.md)
3. Developers
1. [Developers setup](developers/developers-setup.md)
2. [Release process](developers/release-process.md)
Loading