Browse Source

Setup script bugfix

philemon 11 years ago
parent
commit
ca9a468a40
5 changed files with 20 additions and 24 deletions
  1. 4 3
      doc/MMGenBuildBitcoindMSWin.md
  2. 13 18
      doc/MMGenGettingStarted.md
  3. 1 1
      doc/MMGenInstallOfflineBitcoind.md
  4. 0 0
      mmgen/tests/util.py
  5. 2 2
      setup.py

+ 4 - 3
doc/MMGenBuildBitcoindMSWin.md

@@ -126,14 +126,15 @@ after the line:
 
 		LIBS="$LIBS $BOOST_LIBS $BOOST_CHRONO_LIB"
 
-From the prompt, run `configure` and `make` with the provided arguments:
+From the prompt, run `configure` and `make` with the arguments provided below:
 
 		$ ./configure --without-qt --with-incompatible-bdb CPPFLAGS=-I/usr/include LDFLAGS="-static -L/usr/lib -Wl,--allow-multiple-definition" BOOST_ROOT=/c/boost_1_55_0
 		$ make src/bitcoind.exe
 
 Strip the executable (`strip src/bitcoind.exe`), copy it to your path and test
-by running `bitcoind`.  You may need to supply an argument to the `-datadir`
-option so the daemon can find your wallet and configuration file.
+that the command `bitcoind` works.  You may want to use the `-datadir` option to
+point to the location where you plan to put your `bitcoin.conf` file, wallet and
+blockchain.
 
 [01]: http://download.oracle.com/berkeley-db/db-5.0.32.tar.gz
 [02]: http://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads/index-082944.html

+ 13 - 18
doc/MMGenGettingStarted.md

@@ -222,7 +222,8 @@ with wallet.dat inputs:
 
 For your future transactions with MMGen address inputs, you'll list the MMGen
 seed source (wallet, mnemonic or seed file) on the command line after the
-transaction file, and the required keys will be generated automatically:
+transaction file, and the required keys will be generated automatically, as in
+this example:
 
 		$ mmgen-txsign tx_9D2C3A[1.23].raw B73B58EA-125FB230[256,3].mmdat
 
@@ -237,7 +238,7 @@ using the seed.
 #### 6. Send the transaction (online computer):
 
 Now you're ready for the final step: broadcasting the transaction to the network.
-Copy the `*.sig` file to your online computer, start bitcoind, if it's not
+Copy the `tx_*.sig` file to your online computer, start bitcoind, if it's not
 running, and execute the command:
 
 		$ mmgen-txsend tx_1EDCBA[6.6].sig
@@ -249,7 +250,8 @@ Once the transaction's confirmed by the network, your three new MMGen addresses
 will appear on the listing of `mmgen-txcreate -i`.  Type 'm' at the menu to
 see them displayed in MMGen format.
 
-Congratulations!  You've performed your first MMGen transaction.
+Congratulations!  You've performed your first MMGen transaction and placed your
+first funds under MMGen control.
 
 ### Additional Features
 
@@ -267,17 +269,18 @@ Continuing our example above, generate a mnemonic from the wallet:
 		dirty measure thorn
 
 Note: a 128- or 192-bit seed will generate a shorter mnemonic of 12 or 18
-words.  You may generate a wallet with a these seed lengths using the `'-l'`
+words.  You may generate a wallet with these seed lengths using the `'-l'`
 option to `mmgen-walletgen`.
 
 Though some consider 128 bits of entropy to provide adequate security for the
 foreseeable future, you should stick to the default 256-bit seed length if
 you're not planning to use the mnemonic feature.
 
-NOTE: MMGen mnemonics are generated from the Electrum wordlist, only using
+NOTE: MMGen mnemonics are generated from the Electrum wordlist, but using
 ordinary base conversion instead of Electrum's more complicated algorithm.
 
-Generate addresses 1-11 using the mnemonic instead of the wallet:
+Generate addresses 1-11 of seed 89ABCDEF using the mnemonic instead of the
+wallet:
 
 		$ mmgen-addrgen 89ABCDEF.mmwords 1-11
 		...
@@ -286,7 +289,7 @@ Generate addresses 1-11 using the mnemonic instead of the wallet:
 Compare the first ten addresses with those earlier generated by the wallet.
 You'll see they're the same.
 
-Recover a lost wallet using the mnemonic:
+Regenerate a lost wallet using the mnemonic:
 
 		$ mmgen-walletgen 89ABCDEF.mmwords
 		...
@@ -295,7 +298,7 @@ Recover a lost wallet using the mnemonic:
 Note that the regenerated wallet has a different Key ID but of course the same
 Seed ID.
 
-Seed files bear the extension `*.mmseed` and are listed on the command line the
+Seed files bear the extension `.mmseed` and are listed on the command line the
 same way mnemonic files are.
 
 A seed file for a 256-bit seed looks like this:
@@ -326,8 +329,8 @@ intentionally been made optional to safeguard against looking-over-the-shoulder,
 Van Eyck phreaking and other side-channel attacks.  MMGen commands never print
 private data to the screen unless explicitly asked to.
 
-The output file of any MMGen command may be written to a directory of your
-choice using the `'-d'` option.  For example, on a Linux system you could use
+The output of any MMGen command may be written to a directory of your choice
+using the `'-d'` option.  For example, on a Linux system you could use
 `'-d /dev/shm'` to write key and seed data to volatile memory instead of disk.
 This also has obvious security benefits, ensuring that no sensitive data
 remains on disk after your computer's been powered down.
@@ -385,11 +388,3 @@ find the following tests to be of interest:
 > Print the Electrum wordlist:
 
 			mmgen/tests/mnemonic.py electrum_print
-
-> Show statistics for the Tirosh wordlist:
-
-			mmgen/tests/mnemonic.py tirosh
-
-> Print the Tirosh wordlist:
-
-			mmgen/tests/mnemonic.py tirosh_print

+ 1 - 1
doc/MMGenInstallOfflineBitcoind.md

@@ -16,7 +16,7 @@ path and start it with the command:
 
 Note that in the absence of a blockchain the daemon starts very quickly and
 uses practically no CPU once running.  Thus a low-powered computer such as a
-netbook will serve quite nicely as an offline machine for signing transactions.
+netbook can serve quite nicely as an offline machine for signing transactions.
 
 [00]: https://bitcoin.org/en/download
 

+ 0 - 0
mmgen/tests/utils.py → mmgen/tests/util.py


+ 2 - 2
setup.py

@@ -20,7 +20,7 @@ setup(
 			'mmgen.mn_tirosh',
 			'mmgen.Opts',
 			'mmgen.tx',
-			'mmgen.utils',
+			'mmgen.util',
 			'mmgen.walletgen',
 
 			'mmgen.rpc.__init__',
@@ -38,7 +38,7 @@ setup(
 			'mmgen.tests.mnemonic',
 			'mmgen.tests.mn_tirosh',
 			'mmgen.tests.test',
-			'mmgen.tests.utils',
+			'mmgen.tests.util',
 			'mmgen.tests.walletgen'
 		],
 		scripts=[