Skip to content

Commit 1f4cd22

Browse files
[README] Update.
1 parent 7a215dc commit 1f4cd22

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# FactWallet based on the Electrum - Lightweight Bitcoin client
2-
1+
# Lightweigth FactWallet
32
```
43
Licence: MIT Licence
5-
Author: Escanor Liones
64
Language: Python (>= 3.8)
75
Homepage: https://www.fact0rn.io
86
```
97

108
## Getting started
119

10+
Based on the Bitcoin Electrum Lightweight wallet. See the Contributing section below.
11+
There is still a lot of work that needs to be done.
12+
1213
Electrum itself is pure Python, and so are most of the required dependencies,
1314
but not everything. The following sections describe how to run from source, but here
1415
is a TL;DR:
@@ -102,6 +103,8 @@ $ ./run_electrum
102103

103104
### Run tests
104105

106+
TODO: tests need to be redone for the Fact0rn blockchain.
107+
105108
Run unit tests with `pytest`:
106109
```
107110
$ pytest electrum/tests -v
@@ -123,13 +126,14 @@ $ pytest electrum/tests/test_bitcoin.py -v
123126

124127
## Contributing
125128

129+
130+
126131
Any help testing the software, reporting or fixing bugs, reviewing pull requests
127132
and recent changes, writing tests, or helping with outstanding issues is very welcome.
128133
Implementing new features, or improving/refactoring the codebase, is of course
129134
also welcome, but to avoid wasted effort, especially for larger changes,
130-
we encourage discussing these on the issue tracker or IRC first.
135+
we encourage discussing these on the issue tracker or Discord first.
131136

132-
Besides [GitHub](https://github.com/spesmilo/electrum),
133-
most communication about Electrum development happens on IRC, in the
134-
`#electrum` channel on Libera Chat. The easiest way to participate on IRC is
135-
with the web client, [web.libera.chat](https://web.libera.chat/#electrum).
137+
Besides [GitHub](https://github.com/FACT0RN/FactWallet),
138+
most communication about Electrum development happens on Discord, in the
139+
`Fact0rn` [server](https://discord.gg/Mfzp2QtmQG).

0 commit comments

Comments
 (0)