From 6acb3a370bce1905de0c721092f8890045b6c6cf Mon Sep 17 00:00:00 2001 From: The MMGen Project Date: Tue, 30 Aug 2022 12:06:05 +0000 Subject: [PATCH] update documentation from wiki --- .../Install-MMGen-on-Microsoft-Windows.md | 43 ++++++++----------- doc/wiki/using-mmgen/Test-Suite.md | 15 +++---- 2 files changed, 24 insertions(+), 34 deletions(-) diff --git a/doc/wiki/install-mswin/Install-MMGen-on-Microsoft-Windows.md b/doc/wiki/install-mswin/Install-MMGen-on-Microsoft-Windows.md index 1ce51009..8b394481 100644 --- a/doc/wiki/install-mswin/Install-MMGen-on-Microsoft-Windows.md +++ b/doc/wiki/install-mswin/Install-MMGen-on-Microsoft-Windows.md @@ -77,12 +77,11 @@ Save your changes and double click the icon to launch your MSYS2-enabled PowerShell. From now on, all your work will be done in this terminal. Note that the root of your MSYS2 installation is located in `C:\\msys64`, so the -following commands, for example: +following commands, for example, will produce a listing of the same directory: $ ls /etc # the path as seen within MSYS2 $ ls 'C:\\msys64\etc' # the path as seen by Windows -will produce a listing of the same directory. ### 3. Upgrade MSYS2 @@ -113,9 +112,10 @@ will produce a listing of the same directory. > The server that’s listed first in these files is the one that will used by > default, so you may wish to edit them and place the server you wish to use -> first in the list. For this you may use a text editor such as Notepad: +> first in the list. For this you may use a text editor such as Notepad or +> Nano: - $ notepad /etc/pacman.d/mirrorlist.msys + $ nano /etc/pacman.d/mirrorlist.msys ... repeat for remaining mirrorlist files ... > You need to update your database files as well. The database files and their @@ -133,6 +133,8 @@ will produce a listing of the same directory. >> >> >> +>> +>> >> >> @@ -150,9 +152,6 @@ will produce a listing of the same directory. > trick using '>' works for most shell commands, by the way). Copy `urls.txt` > to your online machine and download the URLs listed in it. -> *NOTE: as of 01.05.2022, files in the `clang64` directory were found under -> `mingw64` instead, so these URLS may have to be edited accordingly.* - > Create a new folder on your offline machine: $ mkdir packages1 @@ -213,11 +212,11 @@ Install the MMGen requirements and their dependencies: Create the `/usr/local/bin` directory. This is where you’ll place various binaries required by MMGen: - $ mkdir -p /usr/local/bin # seen by Windows as C:\\msys64\usr\local\bin + $ mkdir -p /usr/local/bin # seen by Windows as 'C:\\msys64\usr\local\bin' Open your shell’s runtime configuration file in a text editor: - $ notepad ~/.bashrc + $ nano ~/.bashrc Add the following two lines to the end of the file (if this is a Bitcoin-only installation, you may omit the Litecoin and Bitcoin Cash Node components of the @@ -255,27 +254,21 @@ On your offline machine, unpack and enter the archive: $ tar fax scrypt-0.8.20.tar.gz $ cd scrypt-0.8.20 -Open the file `setup.py` in your text editor. Right before the line beginning -with: +Open the file `setup.py` in your text editor. Right before the line reading: - scrypt_module = Extension( + elif sys.platform.startswith('win32'): -add the following line (with no indentation): +insert the following lines, carefully preserving indentation: - includes = ['/mingw64/include'] - -Also change the line: - - libraries = ['libcrypto_static'] - -to read: - - libraries = ['libcrypto'] + elif os.environ.get('MSYSTEM') == 'MSYS': + define_macros = [] + includes = ['/mingw64/include'] + libraries = ['libcrypto'] + CFLAGS.append('-O2') Save the file and exit the editor. Now build and install: - $ python3 setup.py build --compiler=mingw32 - $ python3 setup.py install + $ python3 setup.py install --user ### 8. Clone and copy the secp256k1 library (offline install only) @@ -371,7 +364,7 @@ Congratulations, your installation is now complete, and you can proceed to MMGen on Linux, except for [autosigning][ax], are now supported on MSYS2 too. Please be aware of the following, however: -+ Non-ASCII filenames cannot be used with the Monero wallet syncing tool. This ++ Non-ASCII filenames cannot be used with the `mmgen-xmrwallet` utility. This is an issue with the Monero wallet RPC daemon rather than MMGen. + The Bitcoin Cash Node daemon cannot handle non-ASCII pathnames. This is an diff --git a/doc/wiki/using-mmgen/Test-Suite.md b/doc/wiki/using-mmgen/Test-Suite.md index 4a2addfb..aea97c2b 100644 --- a/doc/wiki/using-mmgen/Test-Suite.md +++ b/doc/wiki/using-mmgen/Test-Suite.md @@ -128,19 +128,15 @@ may also be started and stopped manually at the DOS or MSYS2 prompt as follows #### Ethkey -On Arch Linux systems, ethkey is included in the OpenEthereum package: +On Arch Linux and ArchLinuxArm systems, the ‘ethkey’ utility is included in the +OpenEthereum package: $ pacman -S openethereum -For other systems, you may have to build ethkey from source: +For 64-bit Windows and Linux systems, ‘ethkey’ can be found in the zip archives +distributed with [this release][oz]. - $ sudo apt-get install rustc # skip this if Rust is already installed - $ git clone https://github.com/openethereum/openethereum - $ cd openethereum - $ git checkout v2.6.6 # this version builds on ARM boards - your mileage may vary - $ cargo build -p ethkey-cli --release - $ sudo install --strip ./target/release/ethkey /usr/local/bin - $ cd .. +For other systems (i.e. Debian/Ubuntu ARM), tests involving ‘ethkey’ are skipped. #### Monero note @@ -191,3 +187,4 @@ commands’ output on the screen as they’re being run. [ld]: https://download.litecoin.org/litecoin-0.17.1/ [oe]: Altcoin-and-Forkcoin-Support#a_oe [sc]: Altcoin-and-Forkcoin-Support#a_dt +[oz]: https://github.com/openethereum/openethereum/releases/tag/v3.1.0