Browse Source

Small documentation changes. PGP signing key added.

philemon 11 years ago
parent
commit
19ed9d8096

+ 6 - 0
README.md

@@ -66,3 +66,9 @@ mnemonic or seed or a lost seed from the wallet or mnemonic.
 ### Using MMGen
 ### Using MMGen
 
 
 > #### See [Getting Started with MMGen](doc/MMGenGettingStarted.md)
 > #### See [Getting Started with MMGen](doc/MMGenGettingStarted.md)
+
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+[PGP Public Key](doc/MMGenPubKey.md)
+
+Donate: 15TLdmi5NYLdqmtCqczUs5pBPkJDXRs83w

+ 11 - 10
doc/MMGenBuildBitcoindMSWin.md

@@ -32,19 +32,18 @@ the following at the MSYS prompt:
 		$ cd /c/db-5.0.32/build_unix
 		$ cd /c/db-5.0.32/build_unix
 		$ ../dist/configure --enable-mingw --enable-cxx --disable-replication --prefix=/usr
 		$ ../dist/configure --enable-mingw --enable-cxx --disable-replication --prefix=/usr
 
 
-Edit the source file `db.h` in the `build_unix` directory, move to line 116 and
-change:
+Open the source file `db.h` in your editor.  Change the statement on line 116:
 
 
 		typedef pthread_t db_threadid_t;
 		typedef pthread_t db_threadid_t;
 
 
-to:
+to read:
 
 
 		typedef u_int32_t db_threadid_t;
 		typedef u_int32_t db_threadid_t;
 
 
 **Note:** since `db.h` is created by `configure`, this must be done **after**
 **Note:** since `db.h` is created by `configure`, this must be done **after**
 `configure` is run.
 `configure` is run.
 
 
-Now run `make` and `make install`.
+Save the file and run `make` and `make install`.
 
 
 #### 3. Install the MASM assembler (optional but recommended):
 #### 3. Install the MASM assembler (optional but recommended):
 
 
@@ -62,7 +61,7 @@ run:
 		bjam toolset=gcc link=static threading=single --build-type=minimal stage --with-system --with-filesystem --with-program_options --with-chrono --with-test
 		bjam toolset=gcc link=static threading=single --build-type=minimal stage --with-system --with-filesystem --with-program_options --with-chrono --with-test
 		bjam toolset=gcc link=static threading=multi --build-type=minimal stage --with-thread
 		bjam toolset=gcc link=static threading=multi --build-type=minimal stage --with-thread
 
 
-These commands build just the few libraries you need, saving you from the
+These commands build just the few libraries you need, avoiding the
 time-consuming process of compiling the whole boost package.
 time-consuming process of compiling the whole boost package.
 
 
 #### 5. Build Bitcoind:
 #### 5. Build Bitcoind:
@@ -102,11 +101,11 @@ Edit the following files,
 		src/wallet.cpp
 		src/wallet.cpp
 		src/walletdb.cpp
 		src/walletdb.cpp
 
 
-adding the statement `#include <winsock2.h>` near the top of each file, above
+adding the line `#include <winsock2.h>` near the top of each file, above
 the first `#include` statement.
 the first `#include` statement.
 
 
-At the MSYS prompt, run the following file-copying commands (this needs to be
-done just once):
+At the MSYS prompt, run the following commands (this needs to be done just
+once):
 
 
 		$ cp /mingw/bin/autoreconf-2.68 /mingw/bin/autoreconf
 		$ cp /mingw/bin/autoreconf-2.68 /mingw/bin/autoreconf
 		$ cp /mingw/bin/autoconf-2.68 /mingw/bin/autoconf
 		$ cp /mingw/bin/autoconf-2.68 /mingw/bin/autoconf
@@ -133,8 +132,10 @@ From the prompt, run `configure` and `make` with the arguments provided below:
 
 
 Strip the executable (`strip src/bitcoind.exe`), copy it to your path and test
 Strip the executable (`strip src/bitcoind.exe`), copy it to your path and test
 that the command `bitcoind` works.  You may want to use the `-datadir` option to
 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.
+point to the planned location of your `bitcoin.conf` file, wallet and blockchain.
+Of these files, the only one you need to create is `bitcoind.conf`.  If this file
+or its required user and password and lines are missing, `bitcoind` will exit
+with an error message instructing you how to create it.
 
 
 [01]: http://download.oracle.com/berkeley-db/db-5.0.32.tar.gz
 [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
 [02]: http://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads/index-082944.html

+ 3 - 3
doc/MMGenGettingStarted.md

@@ -175,11 +175,11 @@ the change amount (3.399 BTC in this case) automatically.
 Alternatively, and more conveniently, you can list your three addresses in MMGen
 Alternatively, and more conveniently, you can list your three addresses in MMGen
 format:
 format:
 
 
-		$ mmgen-txcreate -a my_addrs 89ABCDEF:2,3.3 89ABCDEF:3,3.3 89ABCDEF:4
+		$ mmgen-txcreate 89ABCDEF:2,3.3 89ABCDEF:3,3.3 89ABCDEF:4 my_addrs
 
 
 Note that an MMGen address file containing the requested output addresses must
 Note that an MMGen address file containing the requested output addresses must
-be provided on the command line.  In this example, the extra address in the file
-is ignored.
+be provided on the command line.  Any extra addresses in the file will be
+ignored.
 
 
 Now hit ENTER, choose the transaction's input from the list (10 BTC, address
 Now hit ENTER, choose the transaction's input from the list (10 BTC, address
 1F9495H8EJL..., txid 04f97185...,2), and confirm.  If all goes well,
 1F9495H8EJL..., txid 04f97185...,2), and confirm.  If all goes well,

+ 3 - 3
doc/MMGenInstallDependenciesMSWin.md

@@ -96,9 +96,9 @@ The `C:\Python27;C:\Python27\Scripts` you added to your path in Step 1 of this
 page should be included in your PATH variable.  If not, then exit MSYS and open
 page should be included in your PATH variable.  If not, then exit MSYS and open
 a new MSYS window to update your path.
 a new MSYS window to update your path.
 
 
-The MMGen commands beginning with `mmgen-` will now be available (type
-`mmgen-<TAB>` to test) and you may begin experimenting with MMGen as described
-in the first two steps of [Getting Started with MMGen][13].
+The MMGen commands beginning with `mmgen-` should now be available (type
+`mmgen-<TAB>` to test) and you can begin experimenting with MMGen as described
+in the first two steps of [**Getting Started with MMGen**][13].
 
 
 [00]: https://www.dlitz.net/software/pycrypto/
 [00]: https://www.dlitz.net/software/pycrypto/
 [01]: http://www.voidspace.org.uk/python/modules.shtml#pycrypto
 [01]: http://www.voidspace.org.uk/python/modules.shtml#pycrypto

+ 2 - 2
doc/MMGenInstallMSWin.md

@@ -46,8 +46,8 @@ an Internet connection.
 
 
 Be advised that compiling bitcoind on Windows requires some time and patience.
 Be advised that compiling bitcoind on Windows requires some time and patience.
 If you're ready to proceed, first read [**A word on text editors**][09] and
 If you're ready to proceed, first read [**A word on text editors**][09] and
-install a text editor if you haven't yet done so; then follow the link on item 4
-above to begin the build process.
+install a Unix-capable text editor if you haven't yet done so; then follow the
+link on item 4 above to begin the build process.
 
 
 [01]: MMGenInstallMinGW_MSYS.md
 [01]: MMGenInstallMinGW_MSYS.md
 [02]: MMGenInstallDependenciesMSWin.md
 [02]: MMGenInstallDependenciesMSWin.md

+ 59 - 0
doc/MMGenPubKey.md

@@ -0,0 +1,59 @@
+MMGen = Multi-Mode GENerator
+============================
+##### a Bitcoin cold storage solution for the command line
+
+MMGen Signing Key
+-----------------
+
+	-----BEGIN PGP PUBLIC KEY BLOCK-----
+	Version: GnuPG v1.4.11 (GNU/Linux)
+
+	mQINBFM9i58BEADRe35+SOWiSZBjIeCUCSJvMnPxD1hTfIIxuTJ6V61lsGQMlCIe
+	JMnJcNWlpGZlYPUOW49zcXVbZ4lDv1W12cAxAh/1jPrINosJ3jhEMHFj6Na+VKqO
+	ZjsIp7g2uYElV1RowpX6udQNa7loURggMEbsh0duMEvPjsgZEJDVHDRVvhnzWWbK
+	DyVId1KQAEbgBiPuKKWez0UPqtFlCQd61VCrlp6J13ULW2E3Ej57ZIJqsaTMOcBQ
+	PDmL3VUpVeR3TvOUUvWqYk0+R0XGjPKFJBRE3NkMODk2pFw5HVs6JDBSUZo94bzm
+	2N23jKSCdBNfuYG27lYryB7uzoyxEl+Az0oNg0l0yhQPGe/B1yvbN31qnCB20sec
+	m2aLsB7UQvMEtI1G1XiWam3+zu+OQ2o3lCS4En+IjjqTjI2MCVhpyDtW0k8wXYQw
+	ZrI3a0DKK6TY1HsXYBGFCGtg5dAMBzzG7sPva4scEFh9r05R8VFyWgpocNGAvkWS
+	w62oNwAvWjYEJ+IcLyG0uk3XyhOXDhKBBcKYfuFI1OyWRx4xPYuV4c1AVImeGc1u
+	T7n5XFHIEgRGhZ+nKXAny7FGBl+ui0c9Cdx3writWlGogjXZQuRWxZlYzeqzM71W
+	FmY3BzKFvIIzfinhe4KvhQKGpar2YTHXHekLZehgxy1Srq+xkDSkFrGXMwARAQAB
+	tDJQaGlsZW1vbiAoTU1HZW4gU2lnbmluZyBLZXkpIDxtbWdlbi1weUB5YW5kZXgu
+	Y29tPokCOAQTAQIAIgUCUz2LnwIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AA
+	CgkQYtvp5SEvBb6fFBAAkfxxkKbxTEVA0lqNaIrfQcS7soSoMVZpCP3E7DrD6Fgv
+	cR8rwV876OHRxk/ls2t2y6lxlm556gkW+jw7fyxXQUy/Btewww5fIckD75HQrqno
+	cDnc6ytUgMibO6IDNNkRPHnoRrV19DSTBZxNfbJg6tgUqhaFFQaLykesWVTWqx3t
+	vqYtZC1RQyRDgCttehH0e4sVwAilDN8VNez41rBuPK0aAb01wrcG7jd7onZk7lGE
+	m5XE7AwgTwNJ4HzfyZZeR08FfFN36Z17ws2jhR2sB2W4QUUtSp0TE6TJ2+WnHcKL
+	dwK+Pgrn15g4US/dsF1Tb3irNWLhl5Ar/u4FL7rZN5GkSqS7MwPAxYrhEuMNQ093
+	qZHnd0Rr6u+jehJAkRWM7At/2Op0NB/ivb5yR2y2ceyuX3jDPEYLQpagjaz9fMo1
+	WOM493siHNAK1Wl2uD5kEl6ErtagqSdtEkoWtuX4LsS/lmUhKfq0eLAhGCTtsaFQ
+	OazlNcpcqeivI+5KrMKT9dG/4tekQr0COXQ1wk9SGbTnh6rIoe+bhCm0TUTPij7p
+	u0atPUy4Iqm6o5KtGZUGMq84TbLtfJnTdYyifrmXnhunRHhc3P/DsopFQ3N4J9bS
+	khyLmyAdvbFXWupon3Axd5tsobcTY0IDkI2PX8pFIguFrV/OfwRRFnILamlkiHS5
+	Ag0EUz2LnwEQALoNUTpjWoE+g5vb9rYO8BD3V0NUuJ0c0unRg8veMv3RoH5limtT
+	7jA8S0wySJcOIEE05211SxfackoguTSDyeMj8rhCiUukkN4zEJnLnZfQfFKyf+lA
+	C10CUi+V9bw7p3cZpELFi0VZTZWuR6zQkLcVziVeBtKZy5wppPV8+Zmwo6dHNKx8
+	LrmnhJswQydyQ32rDJbIs7RvYq1HcIK4qhH9+03nxec1cYzJSdlDDEihd6Q6H0xQ
+	IvaMkiUKr+0KTtBHvJjsGDIiperUGOXzlB3yMQQx0CM2fTAK8AelhargtdJhr/6M
+	46hHCJ3phSTSh9eYvxXdR0GRh8gTXFwYiVi34LnSo7ktih0AwLotuEwrD8S6pZKu
+	dfIz8/Mh+Sx8G0oLK9u+WMwJR6V78J4Od7zhO1xGyIWiqsKcyNOwbOO/K39QzAef
+	KyUIJ/s8PDzy300lHKq1l8tw5uqcrohyYjMoWWsotwWPe61DmB1NBKxeEPUEXZR8
+	ry2Otn6CD8FSgLBQkmhgwYpZh/vFmJFa9f77ThQu9VKW8EEdBpsyRPxvXr7u6ud6
+	KkXGtbeJVyOj6V5dSaWepHJxjcmEd/UydedMFAee8IfdqViZoaSJMqSG7GQF787w
+	JxtbPcnJ0evD9NiUQa1Wgp2jYNZC9KVXoW4j/ZEeWw3HOv03q/zA+foZABEBAAGJ
+	Ah8EGAECAAkFAlM9i58CGwwACgkQYtvp5SEvBb6QxQ//YsBH36lKWlDhuqypEKBJ
+	2bRSPlB7WCnrl3g0P69XPAkpN0h/D8qDNrestDY4x1jQD7ZZ9PQQxeMTD+rHMwv5
+	pvi+Yoc7NHnu3eRVkvBRNaOGrA+pxaJk31NTTJAhnVe9EySNY25mSN+Skv6GJKu8
+	ItykkCsldhC5EEUvafXu3rLqKTe838eZdLE2OLipwnFO1U7tlf8d2Y4aTfheJKME
+	r7HE6H5XQPOth3qSnoqEMbP6Pn1WdP5zYFRndtoiP2KS6HM8KsH0KdeW6qi4Kyq2
+	A9wMWS5T3KbU0k9xQ3Nigs1wOkXNBmbl8UVgk6x/XzQogkUV3uNAyGi8qzVj7iD0
+	XllJ+cr6KIs1SxpgaArYb0D1weTNMxNt/6/rHl2+BVTlQ2dWEVXiod/mD/uWEJp5
+	F9XY7EjvrpP1Oo/NufsRO+cVQ3Edt9I7W1BiJ59MY8Rh2a40ndy2GEQ4cn8hy4qi
+	oSdY0CYjcLCXpXWdJzyTgMQTvmFTFqiVishkor543JoRpS3RdAz+ahrUMgMRrHHH
+	drdTi6+69ocAUPJt6gtlb9upWZtFeQ3gKyq3mYKHqNrBS+CQ3lz2yjQSp3MQuhXa
+	8gVGgOvOF6tX6j6O1+SyFsZjHWDgJObtVSZ52odVJFII2bPAO/7tYtiaHohmHLXS
+	dRrWK1eeHDwJ7AnLSfwxBGc=
+	=Amww
+	-----END PGP PUBLIC KEY BLOCK-----