Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gulbanana committed Mar 23, 2024
1 parent 6b67d61 commit 2493967
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
## [0.15.3](releases/tag/v0.15.3)

### Added
- Relatively comprehensive branch management support - create, delete, push and fetch.
- Display Git remotes in the status bar, with all-branches push & fetch commands.
- Relatively comprehensive branch management - create, delete, rename, forget, push and fetch.
- Display Git remotes in the status bar, with commands to push or fetch all their branches.
- Display Git tags (readonly; they aren't really a Jujutsu concept).
- Display edges to commits that aren't in the queried revset, by drawing a line to nowhere.
- Detect changes made by other Jujutsu clients and merge the operation log automatically.
- Improved keyboard support and focus behaviour.
- Window title includes the workspace path (when one is open).
- On Windows, the taskbar icon has a jump list.
- On Windows, the taskbar icon has a jump list with links to recent workspaces.
- New config options:
* `gg.queries.log-page-size` for tuning performance on large repositories.
* `gg.ui.mark-unpushed-branches` to control whether local-only branches are called out.
Expand All @@ -22,6 +22,7 @@
- The AppImage build wasn't picking up the working directory correctly. This is fixed, and
you can also specify a workspace to open on the commandline as an alternative.
- Watchman support (core.fsmonitor) was not enabled.
- Various design improvements.

## [0.15.2](releases/tag/v0.15.2)

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![screenshot](src-tauri/resources/screenshot.png)

GG is an experimental GUI for [Jujutsu](https://github.com/martinvonz/jj). The idea is to take advantage of Jujutsu's composable primitives to present an interactive view of your repository. What if you were always in the middle of an interactive rebase, but this was actually good?
GG is a GUI for the version control system [Jujutsu](https://github.com/martinvonz/jj). It takes advantage of Jujutsu's composable primitives to present an interactive view of your repository. Just imagine: what if you were always in the middle of an interactive rebase, but this was actually good?

## Installation
GG is a desktop application with a keyboard & mouse interface, written in [Tauri](https://tauri.app/). Binaries are available for several platforms on the [releases page](https://github.com/gulbanana/gg/releases). Use the `.dmg` or `.app.tar.gz` on MacOS, and the `.msi` or `.exe` on Windows. To build from source, run `npm install` followed by `npm run tauri build`.
Expand All @@ -11,7 +11,7 @@ GG is a desktop application with a keyboard & mouse interface, written in [Tauri
Put `gg` on your path and run it from a Jujutsu workspace, pass the workspace directory as an argument or launch it separately and use the Repository->Open menu item. Tips:
- On MacOS, try adding `/Applications/gg.app/Contents/MacOS/` to your PATH environment variable. On Windows, add `C:\Program Files\gg\`.
- Using `gg &` on MacOS/Linux or `start gg` on Windows will run in the background without blocking your shell.
- Pass `--help` to see a few command line arguments you can use.
- `gg --help` will display some possible command-line arguments.

### Configuration
GG uses `jj config`; `revset-aliases.immutable_heads()` is particularly important, as it determines how much history you can edit. GG has some additional settings of its own, with defaults and documentation [here](src-tauri/src/config/gg.toml).
Expand All @@ -22,7 +22,7 @@ GG doesn't require [JJ](https://martinvonz.github.io/jj/latest/install-and-setup
- Use the right pane to inspect and edit revisions - set descriptions, issue commands, view their changes and parents.
- Drag revisions around to rebase them; move them into or out of a revision's parents to add merges and move entire subtrees. Or just abandon them entirely.
- Drag files around to squash them into new revisions or throw away changes (restoring from parents).
- Drag branches around to set their pointers.
- Drag branches around to set or delete them.
- Right click on any of the above for more actions.
- Push and fetch git changes using the bottom bar.
- Undo anything with ⟲ in the bottom right corner.
Expand Down

0 comments on commit 2493967

Please sign in to comment.