diff --git a/Getting-Started-with-MMGen.md b/Getting-Started-with-MMGen.md index af47939..7618cf5 100644 --- a/Getting-Started-with-MMGen.md +++ b/Getting-Started-with-MMGen.md @@ -26,6 +26,7 @@ * [BIP 125 replace-by-fee (RBF) transactions](#a_rbf) * [With an online (hot) wallet](#a_rbf_onl) * [With an offline (cold storage) wallet](#a_rbf_onf) +* [Keeping your installation up to date](#a_utd) ### Preliminaries @@ -868,6 +869,42 @@ them in turn until you get a confirmation: $ mmgen-txsend 124FFF[0.1,150].sigtx # ...if this doesn’t confirm, then $ mmgen-txsend 73DABB[0.1,200].sigtx +#### Keeping your installation up to date + +To make sure you have all the latest features and bugfixes, it’s a good idea to +keep your MMGen installation upgraded to the latest version. MMGen does no +checking for updates itself, so the following steps should be performed by you +on a periodic basis. + +If you’ve deleted or lost your local copy of the MMGen repository, clone it +again from Github or Gitlab: + + $ git clone https://github.com/mmgen/mmgen.git # Github + $ git clone https://gitlab.com/mmgen/mmgen.git # Gitlab + +Enter the repository and check out the master branch. Pull the latest changes +from the remote repository: + + $ cd mmgen + $ git checkout master + $ git pull + +Check out the current stable version for your operating system: + + $ git checkout stable_linux # for Linux-based systems + $ git checkout stable_msys2 # for Microsoft Windows / MSYS2 systems + +Note that if you want to try out the latest “bleeding edge” (and possibly +unstable) features, you can just remain on the master branch and omit the +preceding step. Information on recently added features can be found by typing +`git log` or visiting the commits page on [Github][hc] or [Gitlab][lc]. + +Check the latest release notes in `doc/release-notes` and make note of any new +features or requirements. Now perform the install: + + $ sudo ./setup.py install # Linux + $ ./setup.py install # Windows / MSYS2 + [01]: Tracking-and-spending-ordinary-Bitcoin-addresses [02]: https://tpfaucet.appspot.com [03]: Recovering-Your-Keys-Without-the-MMGen-Software @@ -875,4 +912,5 @@ them in turn until you get a confirmation: [05]: Key-address-files [06]: Subwallets [07]: autosign-[MMGen-command-help] - +[hc]: https://github.com/mmgen/mmgen/commits/master +[lc]: https://gitlab.com/mmgen/mmgen/commits/master