tAdd development notes in Readme. - obelisk - Electrum server using libbitcoin as its backend
HTML git clone https://git.parazyd.org/obelisk
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit 9c45b8a5e218a974820306ef4b0991bde036b37d
DIR parent 64c6303c66afdeb7ae16f5de5166d7de1c5c0d96
HTML Author: parazyd <parazyd@dyne.org>
Date: Tue, 13 Apr 2021 16:20:50 +0200
Add development notes in Readme.
Diffstat:
M README.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+), 0 deletions(-)
---
DIR diff --git a/README.md b/README.md
t@@ -51,3 +51,20 @@ Obelisk can also be installed with setuptools:
```
python3 setup.py install --user
```
+
+
+Development
+-----------
+
+The code is written to be short and concise. `run_obelisk` is the
+entry point to start the server, but most of the actual logic is
+in `obelisk/protocol.py` and `obelisk/zeromq.py`. `protocol.py`
+implements the ElectrumX protocol, and `zeromq.py` implements the
+libbitcoin side of things.
+
+Before committing code, please run `./res/format_code.py` to format
+the codebase to a certain code style. This scripts depends on `black`
+and `yapf`.
+
+You can chat about Obelisk on Freenode IRC, either `#electrum` or
+`#libbitcoin`.