From 7d7bb5dbcef2f1304058db653a54e22e814310b5 Mon Sep 17 00:00:00 2001 From: The MMGen Project Date: Tue, 13 Jun 2023 18:32:20 +0000 Subject: [PATCH] update documentation from wiki (minor changes) --- .../install-linux/Install-MMGen-on-Linux.md | 4 ++-- .../Install-MMGen-on-Microsoft-Windows.md | 22 +++++++++---------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/wiki/install-linux/Install-MMGen-on-Linux.md b/doc/wiki/install-linux/Install-MMGen-on-Linux.md index b92c35fb..87cafd9b 100644 --- a/doc/wiki/install-linux/Install-MMGen-on-Linux.md +++ b/doc/wiki/install-linux/Install-MMGen-on-Linux.md @@ -27,9 +27,9 @@ $ python3 -m pip install --user --upgrade pip setuptools build wheel ``` If you get an ‘externally-managed-environment’ error (with Debian bookworm, -for example), add --break-system-packages to the command line. Note that this +for example), add `--break-system-packages` to the command line. Note that this will not in fact break any system packages, as pip installs all packages under -the user’s home directory when --user is in effect. +the user’s home directory when `--user` is in effect. #### Install MMGen: 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 8cc995b2..fa609d6d 100644 --- a/doc/wiki/install-mswin/Install-MMGen-on-Microsoft-Windows.md +++ b/doc/wiki/install-mswin/Install-MMGen-on-Microsoft-Windows.md @@ -69,7 +69,7 @@ $ ls /etc # the path as seen within MSYS2 $ ls 'C:\\msys64\etc' # the path as seen by Windows ``` -### 3. Upgrade MSYS2 +### 2. Upgrade MSYS2 #### Online users: @@ -174,7 +174,7 @@ $ pacman -U packages1/* > Your system upgrade is now complete. -### 4. Install MSYS2 MMGen dependencies +### 3. Install MSYS2 MMGen dependencies Now that your system’s fully up to date, you’re ready to install the packages specifically required by MMGen. @@ -213,7 +213,7 @@ pacman -S tar git vim autoconf automake-wrapper autogen libtool cygrunsrv \ mingw-w64-ucrt-x86_64-python-pyreadline3 ``` -### 5. Set up your environment +### 4. Set up your environment Create the `/usr/local/bin` directory. This is where you’ll place various binaries required by MMGen: @@ -241,7 +241,7 @@ export PYTHONUTF8=1 Save and exit. Close and reopen the terminal window to update your working environment. -### 6. Install the Python ECDSA library (offline install only) +### 5. Install the Python ECDSA library (offline install only) On your online machine: @@ -255,7 +255,7 @@ Copy the downloaded file to your offline machine and install: $ python3 -m pip install --user ecdsa-*.whl ``` -### 7. Install the standalone scrypt package (required for strong password hashing) +### 6. Install the standalone scrypt package (required for strong password hashing) Thanks to a faulty implementation of the `scrypt` function included in Python’s `hashlib`, the standalone `scrypt` module is required for stronger-than-default @@ -274,7 +274,7 @@ Enter the repo root and edit the file ‘setup.py’, adding the following lines before the line beginning with `elif sys.platform.startswith('win32'):`, making sure to preserve indentation: -```text +```python elif os.environ.get('MSYSTEM') == 'UCRT64': define_macros = [] includes = [] @@ -290,7 +290,7 @@ $ python3 -m build --no-isolation $ python3 -m pip install --user dist/*.whl ``` -### 8. Clone and copy the secp256k1 library (offline install only) +### 7. Clone and copy the secp256k1 library (offline install only) On your online machine, clone the secp256k1 repository from Github: @@ -307,7 +307,7 @@ $ cp -a /path/to/secp256k1/repo/secp256k1 ~/.cache/mmgen $ ls ~/.cache/mmgen/secp256k1/autogen.sh # check that files were correctly copied ``` -### 9. Install MMGen +### 8. Install MMGen Now you’re ready to install MMGen itself. On your online machine, clone the repository: @@ -343,7 +343,7 @@ documentation. occasion. Note that MMGen has a test suite. Refer to the [Test Suite][ts] wiki page for details. -### 10. Install Python Ethereum dependencies (Ethereum users only) +### 9. Install Python Ethereum dependencies (Ethereum users only) If you’ll be using MMGen with Ethereum, then you must install a few dependencies. From the MMGen repository root, type the following: @@ -365,7 +365,7 @@ directory containing the files and install them as follows: $ python3 -m pip install --no-deps --user *.whl ``` -### 11. Install and launch your coin daemons +### 10. Install and launch your coin daemons At this point your MMGen installation will be able to generate wallets, along with keys and addresses for all supported coins. However, if you intend to do @@ -390,7 +390,7 @@ Please note that Ethereum daemons perform rather poorly under Windows due to threading limitations. Unless you have very fast hardware, transacting and syncing the blockchain could be painfully slow. -### 12. You’re done! +### 11. You’re done! Congratulations, your installation is now complete, and you can proceed to [**Getting Started with MMGen**][gs]. Note that all features supported by