mastermb2 / electrum-nmc Goto Github PK

Licence: GNU GPLv3+ for Electrum-DOGE components; CC BY 4.0 for Namecoin logo, MIT Licence for all other components
Author: The Namecoin developers; based on Electrum by Thomas Voegtlin and Electrum-DOGE by The Electrum-DOGE contributors
Language: Python (>= 3.6)
Homepage: https://www.namecoin.org/ ; original Electrum Homepage at https://electrum.org/

Electrum-NMC is a pure python application. If you want to use the Qt interface, install the Qt dependencies:

sudo apt-get install python3-pyqt5

If you downloaded the official package (tar.gz), you can run Electrum-NMC from its root directory without installing it on your system; all the python dependencies are included in the 'packages' directory. To run Electrum-NMC from its root directory, just do:

./run_electrum_nmc

You can also install Electrum-NMC on your system, by running this command:

sudo apt-get install python3-setuptools
python3 -m pip install .[fast]

This will download and install the Python dependencies used by Electrum-NMC instead of using the 'packages' directory. The 'fast' extra contains some optional dependencies that we think are often useful but they are not strictly needed.

If you cloned the git repository, you need to compile extra files before you can run Electrum-NMC. Read the next section, "Development Version".

Check out the code from GitHub:

git clone git://github.com/namecoin/electrum-nmc.git
cd electrum-nmc

Run install (this should install dependencies):

python3 -m pip install .[fast]

Compile the protobuf description file:

sudo apt-get install protobuf-compiler
protoc --proto_path=electrum_nmc --python_out=electrum_nmc electrum_nmc/paymentrequest.proto

Create translations (optional):

sudo apt-get install python-requests gettext
./contrib/make_locale

See contrib/build-linux/README.md.

See contrib/osx/README.md.

See contrib/build-wine/docker/README.md.

See electrum_nmc/gui/kivy/Readme.md.

Electrum-NMC also maintains an auxpow branch. This branch is identical to the upstream Bitcoin version of Electrum (e.g. it doesn't have any name support or Namecoin rebranding), except that it supports AuxPoW (merged mining). It may be useful as a starting point for porting Electrum to other AuxPoW-based cryptocurrencies.