Update readme and Licence master
authorIsmaël Bouya <ismael.bouya@normalesup.org>
Sun, 24 Feb 2019 08:40:58 +0000 (09:40 +0100)
committerIsmaël Bouya <ismael.bouya@normalesup.org>
Sun, 24 Feb 2019 08:40:58 +0000 (09:40 +0100)
LICENSE
build_readme.py [new file with mode: 0644]
readme.md
src/index.html

diff --git a/LICENSE b/LICENSE
index 10202de..1bfa903 100644 (file)
--- a/LICENSE
+++ b/LICENSE
@@ -1,5 +1,7 @@
 The MIT License (MIT)
 Copyright (c) 2014-2016 Ian Coleman
+Copyright (c) 2016-2017 Coinomi Ltd
+Copyright (c) 2019 Ismaël Bouya http://www.normalesup.org/~bouya/
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/build_readme.py b/build_readme.py
new file mode 100644 (file)
index 0000000..a7d8738
--- /dev/null
@@ -0,0 +1,33 @@
+import markdown
+from markdown.extensions.toc import slugify
+
+def lang_slugify(lang):
+    def l_slugify(value, separator):
+        return slugify(lang + "__" + value, separator)
+    return l_slugify
+
+def get_markdown(md_file, lang, table_of_content):
+    with open(md_file, "r") as f:
+        text = f.read()
+
+    return markdown.markdown(
+        text=text,
+        extensions=[
+            'markdown.extensions.codehilite',
+            'markdown.extensions.toc',
+            'markdown.extensions.tables'
+        ],
+        extension_configs={
+            'markdown.extensions.codehilite': {
+                'noclasses': True,
+            },
+            'markdown.extensions.toc': {
+                'title': table_of_content,
+                'slugify': lang_slugify(lang)
+            }
+        })
+
+
+print("<p><a href='#lang-bottom'>Bottom of documentation</a></p>")
+print(get_markdown("readme.md", "en", "Table of contents"))
+print("<hr id='lang-bottom' style='visibility: hidden' />")
index 269743c..b9418c9 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -1,10 +1,20 @@
+[TOC]
+
 # BIP39 Tool
 
 A tool for converting BIP39 mnemonic phrases to addresses and private keys.
 
+This tool tries to find the best world between Coinomi's and
+iancoleman's versions of the implementation, plus a few additions.
+
+Note that this version is centered on my use of Coinomis's wallet, which
+has a few differences to exact BIP44 implementation:
+
+- Coinomi's Ethereum networks don't use change in the BIP44 path.
+
 ## Online Version
 
-https://iancoleman.io/bip39/
+[https://tools.immae.eu/BIP39](https://tools.immae.eu/BIP39)
 
 ## Standalone offline version
 
index 407c246..40b11fc 100644 (file)
                     <p>
                     <span>Alternatively, download the file from the repository</span>
                     -
-                    <a href="https://github.com/iancoleman/bip39">https://github.com/iancoleman/bip39</a>
+                    <a href="https://git.immae.eu/?p=perso/Immae/Projets/Cryptomonnaies/BIP39.git">https://git.immae.eu/?p=perso/Immae/Projets/Cryptomonnaies/BIP39.git</a>
                     </p>
 
                 </div>
 
                     <h2>This project is 100% open-source code</h2>
 
+                    <p>
+                        It tries to merge the best between Coinomi's and
+                        iancoleman's versions of this tool, plus a few
+                        additions. Note that this version is centered on
+                        my use of Coinomi's wallet. Here are the known
+                        issues / differences to exact BIP44
+                        implementation:
+                        <ul>
+                          <li>Coinomi's Ethereum networks don't use change in the BIP44 path.</li>
+                        </ul>
+                    </p>
+
                     <p>
                         <span>Get the source code from the repository</span>
                         -
+                        <a href="https://git.immae.eu/?p=perso/Immae/Projets/Cryptomonnaies/BIP39.git" target="_blank">
+                            https://git.immae.eu/?p=perso/Immae/Projets/Cryptomonnaies/BIP39.git
+                        </a>
+                    </p>
+
+                    <p>
+                        <span>Originally based on</span>
+                        -
                         <a href="https://github.com/iancoleman/bip39" target="_blank">
                             https://github.com/iancoleman/bip39
                         </a>
                     </p>
 
+                    <p>
+                        <span>And</span>
+                        -
+                        <a href="https://github.com/Coinomi/bip39" target="_blank">
+                            https://github.com/Coinomi/bip39
+                        </a>
+                    </p>
+
                     <h3>Libraries</h3>
 
                     <p>