Browse Source

documentation updates

The MMGen Project 3 years ago
parent
commit
5f10005e50

+ 6 - 3
doc/wiki/install-linux/Install-MMGen-on-Linux.md

@@ -22,6 +22,9 @@ For computers with no Internet connection, see **Note for offline machines** bel
 
 #### Install MMGen:
 
+Make sure that `~/.local/bin` is in `PATH`.  Existing MMGen users should delete
+any old installations under `/usr` or `/usr/local`.
+
 	$ git clone https://github.com/mmgen/mmgen.git
 	$ cd mmgen
 	$ git checkout stable_linux # see 'Note' below
@@ -37,12 +40,12 @@ security vulnerabilities are more likely to be present in new code than in a
 stable release.  In addition, new code may require dependencies or installation
 steps not yet covered in the documentation.
 
-Install your coin daemon(s).  To install prebuilt binaries, go [here][01].  To
-install from source, go [here][02].
-
 **Testing Note:** MMGen may be tested in place prior to installation.  Refer to
 the [Test Suite][ts] wiki page for details.
 
+Install your coin daemon(s).  To install prebuilt binaries, go [here][01].  To
+install from source, go [here][02].
+
 ##### Note for offline machines:
 
 The computer you’ve designated for offline use must be connected to the

+ 12 - 7
doc/wiki/install-mswin/Install-MMGen-on-Microsoft-Windows.md

@@ -160,20 +160,20 @@ specifically required by MMGen.
 
 Install the MMGen requirements and their dependencies:
 
-	$ pacman -S tar git vim autoconf automake-wrapper autogen \
-		mingw64/mingw-w64-x86_64-libtool \
+	$ pacman -S tar git vim autoconf automake-wrapper autogen libtool \
+		mingw64/mingw-w64-x86_64-python-build \
+		mingw64/mingw-w64-x86_64-python-wheel \
+		mingw64/mingw-w64-x86_64-python-pip \
+		mingw64/mingw-w64-x86_64-libltdl \
 		mingw64/mingw-w64-x86_64-gcc \
 		mingw64/mingw-w64-x86_64-make \
 		mingw64/mingw-w64-x86_64-pcre \
 		mingw64/mingw-w64-x86_64-libsodium \
-		mingw64/mingw-w64-x86_64-python-build \
-		mingw64/mingw-w64-x86_64-python-wheel \
 		mingw64/mingw-w64-x86_64-python-cryptography \
 		mingw64/mingw-w64-x86_64-python-six \
 		mingw64/mingw-w64-x86_64-python-pexpect \
 		mingw64/mingw-w64-x86_64-python-gmpy2 \
 		mingw64/mingw-w64-x86_64-python-pynacl \
-		mingw64/mingw-w64-x86_64-python-pip \
 		mingw64/mingw-w64-x86_64-python-pysocks \
 		mingw64/mingw-w64-x86_64-python-requests
 
@@ -270,11 +270,16 @@ repository:
 If you’re doing an offline install, then copy the cloned mmgen directory to
 your offline machine.
 
-Enter the directory and install:
+Enter the repo directory and build:
 
 	$ cd mmgen
 	$ git checkout stable_msys2 # See 'Note' below
-	$ ./setup.py install
+	$ python3 -m build --no-isolation
+
+Exit the repo directory and install:
+
+	$ cd ..
+	$ python3 -m pip install --upgrade mmgen/dist/*.whl
 
 **Note:** if you want to use features that have appeared since the latest
 `stable_msys2` release, then you can omit the `git checkout` step and remain on

+ 1 - 1
doc/wiki/using-mmgen/MMGen-Quick-Start-with-Regtest-Mode.md

@@ -6,7 +6,7 @@ All of MMGen’s functionality is available in regtest mode, making it an ideal
 way to learn to use the MMGen wallet without risking real coins.
 
 To send a transaction or perform any other operation as Bob or Alice, just add
-the `--bob` or `--alice` option to the relevant MMGen command.
+the `--bob` or `--alice` option to the applicable MMGen command.
 
 This tutorial provides a quick, hands-on introduction.
 

+ 1 - 1
mmgen/data/version

@@ -1 +1 @@
-13.0.1
+13.1.dev001