README with screenshots, install steps, keys and how to build

README.md

@@ -0,0 +1,126 @@
+<p align="center">
+  <img src="logo.svg" width="96" alt="">
+</p>
+
+<h1 align="center">gites</h1>
+
+<p align="center">
+  A colorful viewer for the history of a git repository.<br>
+  Linux and Windows desktop app, driven from the keyboard.
+</p>
+
+<p align="center">
+  <a href="https://git.wrobel.it/szaman/gites/releases">Download</a> ·
+  <a href="#keys">Keys</a> ·
+  <a href="#build-from-source">Build from source</a>
+</p>
+
+![The commit graph of a small repository, with branches, merges, tags and the preview panel for the selected commit](docs/screenshots/graph.png)
+
+## What it does
+
+- **Draws the commit graph.** Every branch gets its own color. Labels on each commit show
+  local branches, remote branches and tags, and the checked-out commit is ringed.
+- **Hides what you don't need.** Hide one branch with its eye button in the sidebar, or
+  with <kbd>h</kbd> on a commit. Type a pattern such as `prototypes/*` and choose
+  **hide** or **show only**. gites remembers the filters of each repository.
+- **Folds long straight stretches.** Commits in a row that have no branch, tag, fork or
+  merge fold into one dotted line. <kbd>c</kbd> folds all of them, <kbd>space</kbd>
+  opens or closes the one at the selected commit.
+- **Shows the selected commit** in a panel at the bottom: the full message, the author
+  and committer, the hash (click to copy), the parents (click to go there), and the
+  files it changed with the number of added and removed lines.
+- **Shows what changed in a file.** Click a file in the panel, or press <kbd>Enter</kbd>
+  for the first one. Choose one of three layouts with <kbd>v</kbd>:
+  - **One column**, as `git diff` prints it.
+  - **Side by side**, the old file on the left and the new one on the right.
+  - **Inline**, one line per changed line, with removed words struck out and added words
+    marked. Best for prose, such as Markdown.
+
+  In every layout, the words that changed inside a line are marked.
+- **Opens other repositories** from a list of recent ones, or from a folder picker
+  (<kbd>o</kbd>).
+- **Stays current.** gites reloads the repository when its window gets focus again.
+
+![The diff of one file, with old and new side by side and the changed words marked](docs/screenshots/diff.png)
+
+## Install
+
+Download a package from the [releases page](https://git.wrobel.it/szaman/gites/releases):
+
+| System | File |
+|---|---|
+| Debian, Ubuntu | `gites_<version>_amd64.deb` |
+| Fedora, openSUSE | `gites-<version>-1.x86_64.rpm` |
+| Any Linux | `gites_<version>_amd64.AppImage` |
+| Windows, installer | `gites_<version>_x64-setup.exe` |
+| Windows, no install | `gites_<version>_x64_portable.exe` |
+
+gites runs the `git` command, so git must be installed and on your `PATH`.
+
+## Use
+
+```sh
+gites                     # the repository in the current folder
+gites ~/code/my-project   # another repository
+```
+
+## Keys
+
+**In the commit graph**
+
+| Key | Action |
+|---|---|
+| <kbd>↑</kbd> <kbd>↓</kbd> or <kbd>k</kbd> <kbd>j</kbd> | Select the previous or next commit |
+| <kbd>PgUp</kbd> <kbd>PgDn</kbd> | Move one screen up or down |
+| <kbd>g</kbd> <kbd>G</kbd> or <kbd>Home</kbd> <kbd>End</kbd> | Go to the first or last commit |
+| <kbd>Enter</kbd> | Show what changed in the first file of the commit |
+| <kbd>space</kbd> | Fold or unfold the straight stretch at the selected commit |
+| <kbd>c</kbd> | Fold or unfold all straight stretches |
+| <kbd>h</kbd> | Hide the branch of the selected commit |
+| <kbd>y</kbd> | Copy the short hash |
+| <kbd>/</kbd> | Type a filter pattern |
+| <kbd>p</kbd> | Show or hide the preview panel |
+| <kbd>o</kbd> | Open another repository |
+| <kbd>r</kbd> | Reload |
+
+**In a file's diff**
+
+| Key | Action |
+|---|---|
+| <kbd>↑</kbd> <kbd>↓</kbd> or <kbd>k</kbd> <kbd>j</kbd> | Scroll by one line |
+| <kbd>PgUp</kbd> <kbd>PgDn</kbd> | Scroll by one screen |
+| <kbd>g</kbd> <kbd>G</kbd> or <kbd>Home</kbd> <kbd>End</kbd> | Go to the top or bottom |
+| <kbd>n</kbd> <kbd>N</kbd> | Go to the next or previous change |
+| <kbd>]</kbd> <kbd>[</kbd> | Show the next or previous file of the commit |
+| <kbd>v</kbd> | Switch the layout: one column, side by side, inline |
+| <kbd>Esc</kbd> | Go back to the commit graph |
+
+## Where gites keeps its settings
+
+The window layout, the diff layout and the recent repositories are kept in
+`settings.json`, and the filters of each repository in `filters.json`. Both files are in
+the `gites` folder of your data folder: `~/.local/share/gites` on Linux,
+`%APPDATA%\gites` on Windows.
+
+## Build from source
+
+gites is a [Tauri](https://tauri.app) app: the window is Vue and TypeScript, and the part
+that runs git is Rust. [mise](https://mise.jdx.dev) installs the right versions of Node,
+Bun and Rust.
+
+On Linux, Tauri also needs the WebKitGTK development packages. `scripts/ci-setup.sh`
+lists them for Debian and Ubuntu.
+
+```sh
+mise install          # Node, Bun and Rust
+bun install           # packages for the window code
+
+mise run dev          # run gites with live reload; add a path to open a repository
+mise run test         # unit tests for the window code and the Rust code
+mise run check        # type checks for both
+mise run install      # build a release binary and install it as ~/.local/bin/gites
+```
+
+Pushing a tag such as `v1.2.3` builds the Linux and Windows packages and publishes them
+on the releases page.