[electrum] convert README to markdown
ClosedPublic
Actions

Authored by PiRK on Jul 11 2023, 15:44.

Details

Reviewers

bytesofman

Group Reviewers

Restricted Project

Commits

rABCe979c1fc065b: [electrum] convert README to markdown

Summary

The RST format is not automatically converted into a HTML documentation page on the bitcoinabc.org website.
Also, it makes sense to not use multiple doc formats.

Remove the redundant MIT license, authors and language at the top.

Test Plan

I tested all the URL and rendering in my IDE. It wasn't able to make the internal link (to sections in the same doc) work, but it offered autocompletion, so I'm confident that they are right.

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

PiRK created this revision.Jul 11 2023, 15:44

Herald added a reviewer: Restricted Project. · View Herald TranscriptJul 11 2023, 15:44

PiRK requested review of this revision.Jul 11 2023, 15:44

Harbormaster completed remote builds in B24448: Diff 41380.Jul 11 2023, 15:45

bytesofman requested changes to this revision.Jul 11 2023, 18:32

bytesofman added a subscriber: bytesofman.

bytesofman added inline comments.

electrum/README.md
25 ↗	(On Diff #41380)	looks like this is missing what one should just do: `./electrum-abc`

This revision now requires changes to proceed.Jul 11 2023, 18:32

add back deleted line, move misplaced sentence ("This will download and install..." refers to pip3 install . --user), add additional command for installing GUI dependencies.

Fabien added a subscriber: Fabien.Jul 11 2023, 19:17

Fabien added inline comments.