Go to file
nimbosa 4694a65592
Merge branch 'master' into master
2019-01-05 16:28:54 +08:00
.github follow-up prev commit: use less space 2018-02-23 12:01:01 +01:00
.idea Fixed headers and verification 2018-01-17 02:23:18 -06:00
contrib Merge branch 'master' into master 2019-01-05 16:28:54 +08:00
gui Merge branch 'master' into master 2019-01-05 16:28:54 +08:00
icons Merge remote-tracking branch 'up/master' into HEAD 2018-03-05 19:40:10 -06:00
lib Merge branch 'master' into master 2019-01-05 16:28:54 +08:00
plugins Merge remote-tracking branch 'up/master' into HEAD 2018-03-05 19:40:10 -06:00
pubkeys Add my public key 2018-02-11 15:28:01 +01:00
scripts revert mod imp name 2018-01-15 03:05:47 -04:00
snap updated snap packaging details 2017-10-20 23:23:32 +02:00
.gitignore added support for building macOS 2018-01-23 01:17:31 -08:00
.travis.yml Cache dependencies for Travis build 2018-03-03 19:58:31 +01:00
AUTHORS Add self to AUTHORS 2015-11-09 22:53:27 +09:00
Dockerfile Merge branch 'master' into master 2019-01-05 16:28:54 +08:00
Info.plist Revert "follow-up f7200cb6162ba30f4ebd0e94d933f7b7d559cdb2: remove Info.plist" 2017-11-06 19:04:07 +01:00
LICENCE Relicensing 2016-02-24 10:20:30 +01:00
MANIFEST.in remove themes, check python3 in setup.py 2015-10-18 12:43:20 +02:00
README.rst Merge branch 'master' into merge/3.1 2018-09-14 17:19:54 +08:00
RELEASE-NOTES update release notes, add date 2018-03-05 10:39:29 +01:00
app.fil updates for i18n translations 2016-08-01 10:04:11 +02:00
brewfile deps updates 2018-01-25 23:43:24 -08:00
build-docker.sh add docker support 2018-01-31 23:46:50 +01:00
clean.sh Remove electrum, fix readme + clean.sh 2018-02-16 18:49:18 -06:00
config Fix explorers, add coinmarketcap, readme instructions 2018-03-01 13:32:48 -06:00
create-dmg.sh Fix explorers, add coinmarketcap, readme instructions 2018-03-01 13:32:48 -06:00
electrum-env Add Support for Python 3.6+ in ./electrum-env 2018-02-23 05:44:04 -06:00
electrum-zcl Merge remote-tracking branch 'up/master' into HEAD 2018-03-05 19:40:10 -06:00
electrum.conf.sample update doc for sample conf file 2016-04-12 20:01:28 +02:00
electrum.desktop Replaced Electrum BTC icons for ZCL icons 2018-01-18 21:55:26 -05:00
icons.qrc Set icon for offline transactions 2018-01-23 23:50:02 +01:00
packages.txt updated to python-dns 2018-09-01 21:15:04 +01:00
requirements.txt add missing dependency in requirements.txt 2018-01-31 23:34:06 +01:00
run-docker.sh add docker support 2018-01-31 23:46:50 +01:00
setup-mac.sh updated icon and deps 2018-01-25 23:23:30 -08:00
setup-release.py * Fixed create-dmg.sh to use "electrum-zcl" name structure and "Electrum ZCL" for final DMG 2018-02-09 12:56:25 -05:00
setup.py Merge branch 'master' into merge/3.1 2018-09-14 17:19:54 +08:00
tox.ini Let travis run the test using Python3 2017-08-26 08:28:24 +02:00

README.rst

ZCL Electrum - Zclassic Electrum (Lite) Client
==============================================

Latest Release: https://github.com/z-classic/electrum-zcl/releases


Viewing & Sending from Z addresses is not yet supported on this wallet.


Know about your data directory::

    Linux + Mac: ~/.electrum-zcl/
    Windows: C:\Users\YourUserName\AppData\Roaming\Electrum-zcl\

    ~/.electrum-zcl/wallets/ has your wallet files - BACK UP THIS FOLDER

You can also use 'Export Private Keys' and 'Show Seed' from inside the application to write down and store your funds.

Please use the issue tracker for bug reports, feature requests, and other mission-critical information. It is actively monitored by the Zclassic development team. For general support, please visit our Discord: https://discord.gg/45NNrMJ

Development Version
===================

First, clone from Github::

    git clone https://github.com/z-classic/electrum-zcl.git
    cd electrum-zcl

For Mac:
--------

Using Homebrew::

    # Setup Homebrew
    ./setup-mac

    # Install Homebrew dependencies
    brew bundle

    # Install Python dependencies
    pip3 install -r requirements.txt

    # Build icons
    pyrcc5 icons.qrc -o gui/qt/icons_rc.py

    # Compile the protobuf description file
    protoc --proto_path=lib/ --python_out=lib/ lib/paymentrequest.proto

    # Build .app, .dmg
    ./create-dmg.sh

    # Run the .app in dist/, or
    ./electrum-zcl

For Linux:
----------

Install Dependencies::

  sudo apt-get install python-pip pyqt5-dev-tools $(grep -vE "^\s*#" packages.txt  | tr "\n" " ")

  pip3 install -r requirements.txt

  #(Ubuntu with ledger wallet)
  #ln -s /lib/x86_64-linux-gnu/libudev.so.1 /lib/x86_64-linux-gnu/libudev.so

  # For yum installations (no apt-get), or for a clean python env, use Anaconda with Python 3:
  # https://poweruphosting.com/blog/install-anaconda-python-ubuntu-16-04/


Compile the icons file for Qt::

    pyrcc5 icons.qrc -o gui/qt/icons_rc.py

For the Linux app launcher (start menu) icon::

    sudo desktop-file-install electrum.desktop

Compile the protobuf description file::

    protoc --proto_path=lib/ --python_out=lib/ lib/paymentrequest.proto

Create translations (optional)::

    ./contrib/make_locale

Run::

    ./electrum-zcl


For Linux with docker:
----------------------

Build the docker image::

    ./build-docker.sh

Run the docker image::

    ./run-docker.sh


See `contrib/build-osx/`.

Windows
-------

See `contrib/build-wine/`.


Android
-------

See `gui/kivy/Readme.txt` file.

---

To just create binaries, create the 'packages/' directory::

    ./contrib/make_packages

(This directory contains the Python dependencies used by Electrum-ZCL.)


ZCL Hints and Debug
===================

There are several useful scripts in::

    scripts

Here is a good initial check to determine whether things are working (should successfully validate chunks)::

    cd scripts
    python3 block_headers

--

The Zclassic Wiki is located at: https://github.com/z-classic/zclassic/wiki. Please use this as a reference and feel free to contribute.


Original Project Info
---------------------
::

  Forked from **spesmilo/electrum**: https://github.com/spesmilo/electrum

  Licence: MIT Licence
  Author: Thomas Voegtlin
  Language: Python (GUI: Qt, Kivy)
  Platforms: Windows, Mac, Linux, Android
  Homepage: https://electrum.org/


.. image:: https://travis-ci.org/spesmilo/electrum.svg?branch=master
    :target: https://travis-ci.org/spesmilo/electrum
    :alt: Build Status
.. image:: https://coveralls.io/repos/github/spesmilo/electrum/badge.svg?branch=master
    :target: https://coveralls.io/github/spesmilo/electrum?branch=master
    :alt: Test coverage statistics


---

The Zclassic CE Team

ZCL: t3eYEnoMmfUV65CZvPvV2mfAUnfFGoFbkJu