diff --git a/README.md b/README.md index dbd88a4f..e7b90db2 100644 --- a/README.md +++ b/README.md @@ -141,13 +141,13 @@ that widespread standard. #### Supported platforms: -Linux, Armbian, Raspbian, Windows/MSYS2 +Linux, macOS, Windows/MSYS2 ### Download/Install > #### [Install on Microsoft Windows][1] -> #### [Install on Debian, Ubuntu, Raspbian, Armbian or Arch Linux][2] +> #### [Install on Linux or macOS][2] ### Using MMGen Wallet @@ -195,7 +195,7 @@ Donate:  ⊙ XMR: *8B14zb8wgLuKDdse5p8f3aKpFqRdB4i4xj83b7BHYABHMvHifWxiDXeKRELnaxL5FySfeRRS5girgUvgy8fQKsYMEzPUJ8h* [1]: ../../wiki/Install-MMGen-Wallet-on-Microsoft-Windows -[2]: ../../wiki/Install-MMGen-Wallet-on-Linux +[2]: ../../wiki/Install-MMGen-Wallet-on-Linux-or-macOS [3]: ../../wiki/Getting-Started-with-MMGen-Wallet [5]: ../../wiki/MMGen-Signing-Keys [6]: ../../wiki/MMGen-command-help diff --git a/doc/wiki/install-linux/Install-Bitcoind.md b/doc/wiki/install-linux/Install-Bitcoind.md index b5ac5e04..781afb09 100644 --- a/doc/wiki/install-linux/Install-Bitcoind.md +++ b/doc/wiki/install-linux/Install-Bitcoind.md @@ -45,8 +45,8 @@ more low-powered computer as your online machine. >> At the end of the installation process, uncheck the Run box to prevent the >> client from starting. >> ->> **Linux:** Unpack the archive and copy the `bitcoind` and `bitcoin-cli` ->> binaries to `/usr/local/bin`. +>> **Linux, macOS:** Unpack the archive and copy the `bitcoind` and +>> `bitcoin-cli` binaries to `/usr/local/bin`. > **Bitcoin Cash Node (optional):** @@ -57,8 +57,9 @@ more low-powered computer as your online machine. >> Navigate to `C:\Program Files\Bitcoin-Cash-Node\daemon` and rename the file >> `bitcoind` to `bitcoind-bchn` and `bitcoin-cli` to `bitcoin-cli-bchn`. >> ->> **Linux:** Unpack the archive, rename `bitcoind` to `bitcoind-bchn` and ->> copy it to `/usr/local/bin`. +>> **Linux, macOS:** Unpack the archive, rename `bitcoind` to `bitcoind-bchn`, +>> and `bitcoin-cli` to `bitcoin-cli-bchn`, and copy the renamed files to +>> `/usr/local/bin`. > **Litecoin (optional):** @@ -66,7 +67,7 @@ more low-powered computer as your online machine. >> At the end of the installation process, uncheck the Run box to prevent the >> client from starting. >> ->> **Linux:** Unpack the archive and copy the `litecoind` and +>> **Linux, macOS:** Unpack the archive and copy the `litecoind` and >> `litecoin-cli` binaries to `/usr/local/bin`. ### Run (both online and offline computers): @@ -92,9 +93,9 @@ $ litecoind >> Note that the `--listen=0` argument is required only when running Bitcoin >> Core and Bitcoin Cash Node simultaneously. -> **Linux:** +> **Linux, macOS:** ->> Linux users start their daemons like this: +>> Linux and macOS users start their daemons like this: ```text # Bitcoin Core: @@ -102,7 +103,9 @@ $ bitcoind --daemon # Bitcoin Cash Node: $ mkdir ~/.bitcoin-bchn -$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --datadir=$HOME/.bitcoin-bchn --usecashaddr=0 +$ BCH_DATADIR="$HOME/.bitcoin-bchn" # Linux +$ BCH_DATADIR="$HOME/Library/Application Support/Bitcoin-Cash-Node" # macOS +$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --usecashaddr=0 --datadir="$BCH_DATADIR" # Litecoin: $ litecoind --daemon @@ -111,20 +114,18 @@ $ litecoind --daemon > Communicate with your daemons like this: ```text -# Core: +# Bitcoin Core: $ bitcoin-cli help # Bitcoin Cash Node: -$ bitcoin-cli-bchn --rpcport=8432 help +$ BCH_DATADIR="$HOME/.bitcoin-bchn" # Linux +$ BCH_DATADIR="$HOME/Library/Application Support/Bitcoin-Cash-Node" # macOS +$ bitcoin-cli-bchn --rpcport=8432 --datadir="$BCH_DATADIR" help # Litecoin: $ litecoin-cli help ``` -> Warning: If you’re using an existing Bitcoin or Litecoin installation, **move -> your wallet.dat out of harm’s way** before starting the daemon. The new -> wallet now created will be used as your **tracking wallet**. - > If you’re connected to the Internet, the daemon(s) will begin downloading and > verifying the blockchain. This can take from several hours to several days > depending on the speed of your computer, the size of the blockchain(s) in diff --git a/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md b/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux-or-macOS.md similarity index 91% rename from doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md rename to doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux-or-macOS.md index ebe417e2..b831594b 100644 --- a/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux.md +++ b/doc/wiki/install-linux/Install-MMGen-Wallet-on-Linux-or-macOS.md @@ -6,7 +6,7 @@ altcoin support, additional installation steps are required. See* For computers with no Internet connection, see **Note for offline machines** below. -### Install required packages from your Linux distribution: +### Install required packages from your distribution: #### Debian/Ubuntu: @@ -20,14 +20,20 @@ $ sudo apt-get install curl git gcc libtool make autoconf libgmp-dev libssl-dev $ sudo pacman -S curl git gcc libtool make autoconf automake autogen pcre python-pip libsecp256k1 ``` +#### macOS: + +```text +$ brew install python bash autoconf coreutils gcc libmpc libtool readline secp256k1 +``` + You may wish to use a [virtual environment][vv] to keep your MMGen Wallet installation isolated from the rest of your Python packages. If you choose not to use a virtual environment, then you may need to add `--break-system-packages` to the `pip install` command line, depending on your -Python version and Linux distribution. Note that this will not in fact break -any system packages, as pip installs all packages under the user’s home -directory when invoked as user. +Python and OS versions. Note that this will not in fact break any system +packages, as pip installs all packages under the user’s home directory when +invoked as user. ### Upgrade the Python build tools: diff --git a/doc/wiki/install-mswin/Install-Bitcoind.md b/doc/wiki/install-mswin/Install-Bitcoind.md index b5ac5e04..781afb09 100644 --- a/doc/wiki/install-mswin/Install-Bitcoind.md +++ b/doc/wiki/install-mswin/Install-Bitcoind.md @@ -45,8 +45,8 @@ more low-powered computer as your online machine. >> At the end of the installation process, uncheck the Run box to prevent the >> client from starting. >> ->> **Linux:** Unpack the archive and copy the `bitcoind` and `bitcoin-cli` ->> binaries to `/usr/local/bin`. +>> **Linux, macOS:** Unpack the archive and copy the `bitcoind` and +>> `bitcoin-cli` binaries to `/usr/local/bin`. > **Bitcoin Cash Node (optional):** @@ -57,8 +57,9 @@ more low-powered computer as your online machine. >> Navigate to `C:\Program Files\Bitcoin-Cash-Node\daemon` and rename the file >> `bitcoind` to `bitcoind-bchn` and `bitcoin-cli` to `bitcoin-cli-bchn`. >> ->> **Linux:** Unpack the archive, rename `bitcoind` to `bitcoind-bchn` and ->> copy it to `/usr/local/bin`. +>> **Linux, macOS:** Unpack the archive, rename `bitcoind` to `bitcoind-bchn`, +>> and `bitcoin-cli` to `bitcoin-cli-bchn`, and copy the renamed files to +>> `/usr/local/bin`. > **Litecoin (optional):** @@ -66,7 +67,7 @@ more low-powered computer as your online machine. >> At the end of the installation process, uncheck the Run box to prevent the >> client from starting. >> ->> **Linux:** Unpack the archive and copy the `litecoind` and +>> **Linux, macOS:** Unpack the archive and copy the `litecoind` and >> `litecoin-cli` binaries to `/usr/local/bin`. ### Run (both online and offline computers): @@ -92,9 +93,9 @@ $ litecoind >> Note that the `--listen=0` argument is required only when running Bitcoin >> Core and Bitcoin Cash Node simultaneously. -> **Linux:** +> **Linux, macOS:** ->> Linux users start their daemons like this: +>> Linux and macOS users start their daemons like this: ```text # Bitcoin Core: @@ -102,7 +103,9 @@ $ bitcoind --daemon # Bitcoin Cash Node: $ mkdir ~/.bitcoin-bchn -$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --datadir=$HOME/.bitcoin-bchn --usecashaddr=0 +$ BCH_DATADIR="$HOME/.bitcoin-bchn" # Linux +$ BCH_DATADIR="$HOME/Library/Application Support/Bitcoin-Cash-Node" # macOS +$ bitcoind-bchn --daemon --listen=0 --rpcport=8432 --usecashaddr=0 --datadir="$BCH_DATADIR" # Litecoin: $ litecoind --daemon @@ -111,20 +114,18 @@ $ litecoind --daemon > Communicate with your daemons like this: ```text -# Core: +# Bitcoin Core: $ bitcoin-cli help # Bitcoin Cash Node: -$ bitcoin-cli-bchn --rpcport=8432 help +$ BCH_DATADIR="$HOME/.bitcoin-bchn" # Linux +$ BCH_DATADIR="$HOME/Library/Application Support/Bitcoin-Cash-Node" # macOS +$ bitcoin-cli-bchn --rpcport=8432 --datadir="$BCH_DATADIR" help # Litecoin: $ litecoin-cli help ``` -> Warning: If you’re using an existing Bitcoin or Litecoin installation, **move -> your wallet.dat out of harm’s way** before starting the daemon. The new -> wallet now created will be used as your **tracking wallet**. - > If you’re connected to the Internet, the daemon(s) will begin downloading and > verifying the blockchain. This can take from several hours to several days > depending on the speed of your computer, the size of the blockchain(s) in diff --git a/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md b/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md index 694d0e8e..9e6f7b4f 100644 --- a/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md +++ b/doc/wiki/using-mmgen-wallet/Getting-Started-with-MMGen-Wallet.md @@ -873,11 +873,11 @@ Signed transaction written to file 'ABCDEF[0.1].sigtx' *Instead of using a hot wallet, you should consider setting up [transaction autosigning][07] on your offline machine. Autosigning makes it possible to -transact directly from cold storage in a secure and convenient way. Autosigning -is available for Linux-based systems and is tailored for use with Raspberry Pi -and other single-board computers, for which LED support is provided. Old -laptops with their network interfaces disabled also make acceptable signing -devices.* +transact directly from cold storage in a secure and convenient way. Ideally, +your autosigning device should be a Raspberry Pi or other single-board computer +for which MMGen Wallet provides LED support. However, an old laptop running +Linux or macOS would also suffice, provided its network interfaces are removed +or disabled.* To use MMGen Wallet for not only cold storage but also day-to-day transacting, it’s possible to place a portion of your funds in a “hot wallet” on your online @@ -1106,7 +1106,7 @@ install it with `pip install --no-isolation`. Note that additional dependencies may appear from version to version, causing an offline installation to fail. Consult the latest release notes in `doc/release-notes` or your platform’s installation page in the wiki -([Linux][li], [Windows][wi]) for more information. +([Linux, macOS][li], [Windows][wi]) for more information. ##### Development version: @@ -1152,5 +1152,5 @@ $ python3 -m pip install user --upgrade dist/*.whl [ax]: Altcoin-and-Forkcoin-Support#a_xmr [cp]: ../commits/master [mx]: command-help-xmrwallet -[li]: Install-MMGen-Wallet-on-Linux +[li]: Install-MMGen-Wallet-on-Linux-or-macOS [wi]: Install-MMGen-Wallet-on-Microsoft-Windows diff --git a/doc/wiki/using-mmgen-wallet/Test-Suite.md b/doc/wiki/using-mmgen-wallet/Test-Suite.md index bc219af2..343b928c 100644 --- a/doc/wiki/using-mmgen-wallet/Test-Suite.md +++ b/doc/wiki/using-mmgen-wallet/Test-Suite.md @@ -16,7 +16,7 @@ platforms may be much slower. ## Quick start -### Container setup (if applicable) +### LXC container setup (if applicable) The test suite requires the `/dev/loopX` devices to exist and be enabled. If you’re running in an LXC container, note that only privileged containers allow @@ -146,7 +146,7 @@ $ git clone https://github.com/10gic/vanitygen-plusplus $ cd vanitygen-plusplus $ git checkout -b vanitygen-plus e7858035d092 # rewind to fork commit $ make keyconv # ‘mingw32-make.exe keyconv’ for MSYS2 -$ sudo install --strip keyconv /usr/local/bin # Linux +$ sudo install --strip keyconv /usr/local/bin # Linux, macOS $ install --strip keyconv.exe /usr/local/bin # MSYS2 $ cd .. ``` @@ -173,8 +173,8 @@ OpenEthereum package: $ pacman -S openethereum ``` -For 64-bit Windows and Linux systems, ‘ethkey’ can be found in the zip archives -distributed with [this release][oz]. +For 64-bit Windows, Linux and macOS systems, ‘ethkey’ can be found in the zip +archives distributed with [this release][oz]. For other systems (i.e. Debian/Ubuntu ARM), tests involving ‘ethkey’ are skipped.