From b4b0a6855e34f04c5f8d22d8945651e48d250426 Mon Sep 17 00:00:00 2001 From: The MMGen Project Date: Tue, 18 Aug 2026 09:18:09 +0000 Subject: [PATCH] update documentation --- .github/workflows/build.yaml | 2 + README.md | 10 ++-- doc/wiki/Autosigning.md | 2 +- doc/wiki/Getting-Started-with-MMGen-Wallet.md | 6 +-- doc/wiki/Test-Suite.md | 51 ++++++++++--------- mmgen/data/version | 2 +- 6 files changed, 40 insertions(+), 33 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index a7e6b3dc..e45f6bdd 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,5 +1,7 @@ name: Build/Install +run-name: Build and install + on: push: paths: diff --git a/README.md b/README.md index 4906d52c..535e2d4c 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ ##### A terminal-based online/offline cryptocurrency wallet -![build][bb] -![lint][lb] +[![Build/Install][bb_img]][bb] +[![Check code with Ruff, Bandit and Pylint static analyzers][lb_img]][lb] ### Description @@ -205,5 +205,7 @@ Donate: [ms]: ../../wiki/command-help-seedsplit [ta]: ../../wiki/Tool-API [L]: ../../wiki/command-help-tool -[bb]: https://github.com/mmgen/mmgen-wallet/actions/workflows/build.yaml/badge.svg -[lb]: https://github.com/mmgen/mmgen-wallet/actions/workflows/lint.yaml/badge.svg +[bb_img]: https://github.com/mmgen/mmgen-wallet/actions/workflows/build.yaml/badge.svg +[lb_img]: https://github.com/mmgen/mmgen-wallet/actions/workflows/lint.yaml/badge.svg +[bb]: https://github.com/mmgen/mmgen-wallet/actions/workflows/build.yaml +[lb]: https://github.com/mmgen/mmgen-wallet/actions/workflows/lint.yaml diff --git a/doc/wiki/Autosigning.md b/doc/wiki/Autosigning.md index 9f8a6e9f..94c98d4a 100644 --- a/doc/wiki/Autosigning.md +++ b/doc/wiki/Autosigning.md @@ -69,7 +69,7 @@ Enter Version 2 Autosigning. Here the main innovation was to automate all mounting, unmounting, and file copying operations. Version 2 autosigning is sometimes referred to in the -program output and documentation by the term “automount”. +program output and documentation as “automount” autosigning. #### Preparation of signing session: 1. Same as for [Version 1](#as_v1_s) diff --git a/doc/wiki/Getting-Started-with-MMGen-Wallet.md b/doc/wiki/Getting-Started-with-MMGen-Wallet.md index 30263cf4..8175c36c 100644 --- a/doc/wiki/Getting-Started-with-MMGen-Wallet.md +++ b/doc/wiki/Getting-Started-with-MMGen-Wallet.md @@ -113,7 +113,7 @@ This involves an expenditure of both time and money. Fortunately, there’s an alternative: MMGen Wallet’s **regtest mode** creates a virtual network of two users, Bob and Alice, who transact with each other on a -private blockchain. All of MMGen Wallet’s functionality is available in regtest +private blockchain. Most of MMGen Wallet’s functionality is available in regtest mode, making it an ideal way to learn to use the wallet without risking real coins. You may wish to pause here and perform the steps in the tutorial [MMGen Wallet Quick Start with Regtest Mode][04] before continuing on. @@ -130,8 +130,8 @@ other than your MMGen data directory. Otherwise, it’s recommended, as it free you from having to type your wallet filename on the command line.* *The following examples assume that you’ve chosen to use a default wallet. -If you haven’t, then you must include the path to a wallet file or other seed -source in all commands where a seed source is required.* +If you choose not to, then you must include the path to a wallet file or other +seed source in all commands where a seed source is required.* On your **offline** computer, generate a wallet: diff --git a/doc/wiki/Test-Suite.md b/doc/wiki/Test-Suite.md index 997ff6e6..b3f5a348 100644 --- a/doc/wiki/Test-Suite.md +++ b/doc/wiki/Test-Suite.md @@ -38,38 +38,43 @@ Every time the container is started, you may need to create the files afresh: ### BTC-only testing -Install the Bitcoin Core daemon [(source)][sd] [(binaries)][bd]. +#### Install the Bitcoin Core daemon: -Install Pycoin: +Source [here][sd], binaries [here][bd]. + +#### Install the `pycoin`, `ecdsa` and `pexpect` Python packages: + +##### Online install: ```text -# online install: -$ python3 -m pip install pycoin - -# offline install: -$ python3 -m pip download pycoin # online -$ python3 -m pip install --no-build-isolation pycoin-*.tar.gz # offline +$ python3 -m pip install pycoin ecdsa pexpect ``` -CD to the MMGen Wallet repository root: +##### Offline install: + +Download files on online machine: ```text -$ cd path/to/mmgen/repo +$ python3 -m pip download pycoin ecdsa pexpect ``` -Run the following if upgrading from a previous version of MMGen: +Copy downloaded files to offline machine and install: ```text -$ test/clean.py +$ python3 -m pip install --no-build-isolation ``` -Run the test suite in fast mode, skipping altcoin tests (fast mode skips -non-essential tests and uses fewer rounds for repeated tests): +#### Enter the repository root and run the test suite: ```text +$ cd /path/to/mmgen-wallet +$ test/clean.py # do this after an upgrade or previous test run $ test/test-release.sh -FA ``` +The `-A` option skips altcoin tests, while `-F` runs the test suite in fast +mode, skipping non-essential tests and using fewer rounds for repeated tests. + ### Complete testing (BTC plus all supported altcoins) Complete the BTC-only installation steps above, without running the test. @@ -108,8 +113,8 @@ $ scripts/msys2-sshd-setup.sh ``` The daemon should now start automatically every time the system is booted. It -may also be started and stopped manually at the DOS or MSYS2 prompt as follows -(PowerShell must be running with admin privileges): +may also be started and stopped manually at the DOS or MSYS2 prompt (via admin +PowerShell) as follows: ```text # net start msys2_sshd @@ -146,19 +151,17 @@ the zip archives distributed with [this release][oz]. $ git clone https://github.com/10gic/vanitygen-plusplus $ cd vanitygen-plusplus $ git checkout -b vanitygen-plus e7858035d092 # rewind to fork commit -``` - -Optional: On some systems, you may need to edit the Makefile, changing `-lpcre` -to `-lpcre2-posix` on the second line. - -```text -$ make keyconv # ‘mingw32-make.exe keyconv’ for MSYS2 +$ make keyconv # Linux, macOS (see Build note) +$ mingw32-make.exe keyconv # MSYS2 (see Build note) $ sudo install --strip keyconv /usr/local/bin # Linux, macOS $ install --strip keyconv.exe /usr/local/bin # MSYS2 $ cd .. ``` -#### Install Zcash-Mini +Build note: on some systems the build step may fail. In that case you must +edit the Makefile, changing `-lpcre` to `-lpcre2-posix` on the second line. + +#### Install Zcash-Mini (Linux, macOS) Skip the go installation step if go is already installed (check by invoking `go version`) diff --git a/mmgen/data/version b/mmgen/data/version index 679c08f1..ff59fb86 100644 --- a/mmgen/data/version +++ b/mmgen/data/version @@ -1 +1 @@ -16.2.dev11 +16.2.dev12