]> git.immae.eu Git - perso/Immae/Projets/Cryptomonnaies/BIP39.git/blob - readme.md
update readme with Slimcoin-specific text
[perso/Immae/Projets/Cryptomonnaies/BIP39.git] / readme.md
1 # BIP39 Tool
2
3 A tool for converting BIP39 mnemonic phrases to addresses and private keys.
4
5 ## Online Version
6
7 Upstream demo: https://iancoleman.github.io/bip39/
8
9 Slimcoin: TBD
10
11 ## Standalone offline version
12
13 Download `bip39-standalone.html`
14
15 Open the file in a browser by double clicking it.
16
17 This can be compiled from source using the command `python compile.py`
18
19 ## Usage
20
21 Enter your BIP39 phrase into the 'BIP39 Phrase' field, or press
22 'Generate Random Phrase'
23
24 If required, set the derivation path, although the defaults are quite usable.
25
26 See the table for a list of addresses generated from the phrase.
27
28 Toggle columns to blank to easily copy/paste a single column of data, eg to
29 import private keys into a wallet or supply someone with a list of addresses.
30
31 The BIP32 keys can be used at [bip32.org](https://bip32.org) if desired.
32
33 ## Donations
34
35 Since this project is the efforts of many people, most of which don't appear in
36 the obvious places like code or issues, donating to the project itself causes
37 significant operational difficulties.
38
39 As a result, if you would like to support this project financially you are
40 encouraged to donate to one of the many groups that makes the internet a place
41 amenable to projects such as this one.
42
43 [Donation-accepting organizations and projects](https://en.bitcoin.it/wiki/Donation-accepting_organizations_and_projects)
44
45 If the list is too difficult to choose from, the EFF is a good choice.
46
47 [Electronic Frontier Foundation](https://supporters.eff.org/donate)
48
49 or for a direct bitcoin address, consider donating to the
50 [Free Software Foundation](https://www.fsf.org/about/ways-to-donate/)
51 at 1PC9aZC4hNX2rmmrt7uHTfYAS3hRbph4UN
52
53 ![alt text](https://static.fsf.org/nosvn/images/bitcoin_qrcodes/fsf.png "FSF Bitcoin Address")
54
55 ## Making changes
56
57 Please do not make modifications to `bip39-standalone.html`, since they will
58 be overwritten by `compile.py`.
59
60 Make changes in `src/*` and apply them using the command `python compile.py`
61
62 # Tests
63
64 Tests depend on [phantomjs](http://phantomjs.org/).
65
66 Run tests from the command-line
67
68 ```
69 $ phantomjs tests.js
70 ```
71
72 # License
73
74 This BIP39 tool is released under the terms of the MIT license. See LICENSE for
75 more information or see https://opensource.org/licenses/MIT.