git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
+## Using nmbug, simple example
-## Using nmbug
+ # get the latest version of the tags
+ $ nmbug pull
- # suck in the tags
- $ nmbug checkout
-
- [ do some tagging; see below for conventions ]
+ # do some tagging; see below for conventions
+
+ $ notmuch tag +notmuch::patch $id
+ # write the tag changes from the notmuch
$ nmbug commit
+## Using nmbug, doing the same thing with more steps
+
+ # get the latest version of the tags
+ $ nmbug fetch
+
+ # Optionally inspect the fetched changes
+
+ $ nmbug status
+ a tags/id1/patch
+ d tags/id2/pushed
+
+ # merge the fetched tags into notmuch
+ $ nmbug merge
+
+ # observe status is clear now,
+ $ nmbug status
+
+ # make the tag changes
+ $ notmuch tag +notmuch::patch id
+
+ # double checkout your changes
+ $ nmbug status
+ A tags/id/patch
+
+ # write the tag changes
+ $ nmbug commit
## Submitting tags.
tags/87aa8j7hqu.fsf@zancas.localnet/patch
tags/87aa8j7hqu.fsf@zancas.localnet/pushed
-The `%25` represents hex code for a character that cannut be used directly
+The `%25` represents hex code for a character that cannot be used directly
(in this case %, only because it is needed as an escape).
### Assumptions