modified: README.md

This commit is contained in:
The MMGen Project 2013-12-02 20:13:45 +04:00
commit 2d047674ec

View file

@ -1,7 +1,7 @@
# mmgen = Multi-Mode GENerator
## a Bitcoin cold storage solution for the command line
NOTE: For the time being, MMGen should be considered Alpha software.
NOTE: For the time being, MMGen should be considered experimental software.
Downloading and testing it out is easy, risk-free and encouraged.
However, spending significant amounts of BTC into your mmgen-generated
addresses is done at your own risk.
@ -229,20 +229,27 @@ addresses is done at your own risk.
### Test suite:
> To see what tests are available, run the scripts in the 'tests'
> directory with no arguments. Some may find the following tests
> interesting:
> directory with no arguments. Among others, you might find the
> following tests to be of interest:
>> Compare 10 addresses generated by 'keyconv' with internally-generated ones:
>> Compare 10 addresses generated by 'keyconv' with mmgen's
>> internally-generated ones:
>>> `tests/bitcoin.py keyconv_compare_randloop 10`
>> Convert a string to base 58 and back:
>>> `tests/bitcoin.py strtob58 'a string'`
>> Convert a hex number to base 58 and back:
>>> `tests/bitcoin.py hextob58 deadbeef`
>> Perform 1000 hex -> base58 -> hex conversions, comparing results stringwise:
>>> `tests/bitcoin.py hextob58_pad_randloop 1000`
>> Generate a 12-word mnemonic for a random 128-bit seed:
>> Generate a 12-word mnemonic from a random 128-bit seed:
>>> `tests/mnemonic.py random128`
>> Ditto, for a random 192-bit seed:
>> An 18-word mnemonic from a random 192-bit seed:
>>> `tests/mnemonic.py random192`
>> Ditto, for a random 256-bit seed:
>> A 24-word mnemonic from a random 256-bit seed:
>>> `tests/mnemonic.py random256`