diff options
| author | Michael Muré <batolettre@gmail.com> | 2020-03-01 12:50:22 +0100 |
|---|---|---|
| committer | Michael Muré <batolettre@gmail.com> | 2020-03-01 12:50:22 +0100 |
| commit | 8365c6334edea95a38b9b7d0184be7c537c2bee9 (patch) | |
| tree | c271afc2900a9c1a311ebd798d8d259d4564a11b /doc | |
| parent | 710d85664e6cf933d2b1691871a4246b8e7eceb3 (diff) | |
| download | git-bug-8365c6334edea95a38b9b7d0184be7c537c2bee9.tar.gz | |
doc: refresh the github howto
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/howto-github.md | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/howto-github.md b/doc/howto-github.md index 44f24927..672aa8b2 100644 --- a/doc/howto-github.md +++ b/doc/howto-github.md @@ -2,8 +2,16 @@ [git-bug](https://github.com/MichaelMure/git-bug) is a standalone distributed bug-tracker that is embedded in git. In short, if you have a git repository you can use it to store bugs alongside your code (without mixing them though!), push and pull them to/from a normal git remote to collaborate. +<p align="center"> + <img src="../misc/diagrams/native_workflow.png" alt="Native workflow"> +</p> + Bridges with other bug-trackers are first-class citizen in `git-bug`. Notably, they are bidirectional, incremental and relatively fast. This means that a perfectly valid way to use `git-bug` is as a sort of remote for Github where you synchronize all the issues of a repository to later read and edit them and then propagate your changes back to Github. +<p align="center"> + <img src="../misc/diagrams/bridge_workflow.png" alt="Bridge workflow"> +</p> + This has several upsides: - works offline, including edition - browsing is pretty much instant @@ -12,7 +20,7 @@ This has several upsides: ## Installation -Follow the [installation instruction](https://github.com/MichaelMure/git-bug#install). The simplest way is to download a pre-compiled binary from [the latest release](https://github.com/MichaelMure/git-bug/releases/latest) and to put it anywhere in your `$PATH`. +Follow the [installation instruction](https://github.com/MichaelMure/git-bug#installation). The simplest way is to download a pre-compiled binary from [the latest release](https://github.com/MichaelMure/git-bug/releases/latest) and to put it anywhere in your `$PATH`. Check that `git-bug` is properly installed by running `git bug version`. If everything is alright, the version of the binary will be displayed. @@ -22,9 +30,9 @@ Check that `git-bug` is properly installed by running `git bug version`. If ever 1. Choose `github`. 1. Type a name for the bridge configuration. As you can configure multiple bridges, this name will allow you to choose when there is an ambiguity. 1. Setup the remote Github project. The wizard is smart enough to inspect the git remote and detect the potential project. Otherwise, enter the project URL like this: `https://github.com/MichaelMure/git-bug` + 1. Enter your login on Github 1. Setup an authentication token. You can either use the interactive token creation, enter your own token or select an existing token, if any. 1. Run `git bug bridge pull` and let it run to import the issues and identities. -1. Find your imported identity by running `git bug user ls` and select it as your own with `git bug user adopt <id>` ## Basic usage |