Browse Source

update documentation from wiki

The MMGen Project 3 years ago
parent
commit
6acb3a370b

+ 18 - 25
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.
 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
 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 /etc              # the path as seen within MSYS2
 		$ ls 'C:\\msys64\etc'  # the path as seen by Windows
 		$ ls 'C:\\msys64\etc'  # the path as seen by Windows
 
 
-will produce a listing of the same directory.
 
 
 ### <a name='a_ug'>3. Upgrade MSYS2</a>
 ### <a name='a_ug'>3. Upgrade MSYS2</a>
 
 
@@ -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
 > 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
 > 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 ...
 		... repeat for remaining mirrorlist files ...
 
 
 > You need to update your database files as well.  The database files and their
 > 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.
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/i686/mingw32.db.sig>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/i686/mingw32.db.sig>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/clang64/clang64.db>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/clang64/clang64.db>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/clang64/clang64.db.sig>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/clang64/clang64.db.sig>  
+>> <https://mirror.yandex.ru/mirrors/msys2/mingw/clang32/clang32.db>  
+>> <https://mirror.yandex.ru/mirrors/msys2/mingw/clang32/clang32.db.sig>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/ucrt64/ucrt64.db>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/ucrt64/ucrt64.db>  
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/ucrt64/ucrt64.db.sig>
 >> <https://mirror.yandex.ru/mirrors/msys2/mingw/ucrt64/ucrt64.db.sig>
 
 
@@ -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`
 > trick using '>' works for most shell commands, by the way).  Copy `urls.txt`
 > to your online machine and download the URLs listed in it.
 > 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:
 > Create a new folder on your offline machine:
 
 
 		$ mkdir packages1
 		$ 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
 Create the `/usr/local/bin` directory.  This is where you’ll place various
 binaries required by MMGen:
 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:
 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
 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
 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
 	$ tar fax scrypt-0.8.20.tar.gz
 	$ cd scrypt-0.8.20
 	$ cd scrypt-0.8.20
 
 
-Open the file `setup.py` in your text editor.  Right before the line beginning
-with:
-
-	scrypt_module = Extension(
-
-add the following line (with no indentation):
-
-	includes = ['/mingw64/include']
-
-Also change the line:
+Open the file `setup.py` in your text editor.  Right before the line reading:
 
 
-	libraries = ['libcrypto_static']
+	elif sys.platform.startswith('win32'):
 
 
-to read:
+insert the following lines, carefully preserving indentation:
 
 
-	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:
 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
 
 
 ### <a name='a_se'>8. Clone and copy the secp256k1 library (offline install only)</a>
 ### <a name='a_se'>8. Clone and copy the secp256k1 library (offline install only)</a>
 
 
@@ -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.
 MMGen on Linux, except for [autosigning][ax], are now supported on MSYS2 too.
 Please be aware of the following, however:
 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.
   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
 + The Bitcoin Cash Node daemon cannot handle non-ASCII pathnames.  This is an

+ 6 - 9
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
 #### 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
 	$ 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
 #### 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/
 [ld]: https://download.litecoin.org/litecoin-0.17.1/
 [oe]: Altcoin-and-Forkcoin-Support#a_oe
 [oe]: Altcoin-and-Forkcoin-Support#a_oe
 [sc]: Altcoin-and-Forkcoin-Support#a_dt
 [sc]: Altcoin-and-Forkcoin-Support#a_dt
+[oz]: https://github.com/openethereum/openethereum/releases/tag/v3.1.0