Skip to content
Snippets Groups Projects
README.md 2.44 KiB
Newer Older
inso's avatar
inso committed
<!-- Landscape | [![Code Health](https://landscape.io/github/ucoin-io/cutecoin/dev/landscape.svg?style=flat)](https://landscape.io/github/ucoin-io/cutecoin/dev) -->
inso's avatar
inso committed

![cutecoin logo](https://raw.github.com/ucoin-io/cutecoin/master/cutecoin.png)
inso's avatar
inso committed

Moul's avatar
Moul committed
Cutecoin [![Coverage Status](https://coveralls.io/repos/ucoin-io/cutecoin/badge.svg?branch=dev)](https://coveralls.io/r/ucoin-io/cutecoin) [![Build Status](https://travis-ci.org/ucoin-io/cutecoin.svg?branch=travis)](https://travis-ci.org/ucoin-io/cutecoin) [![Build status](https://ci.appveyor.com/api/projects/status/0wmo0rk5mds5t3lr/branch/dev)](https://ci.appveyor.com/project/Insoleet/cutecoin/branch/dev) [![Translation status](http://weblate.ucoin.io/widgets/cutecoin/-/svg-badge.svg)](http://weblate.ucoin.io/engage/cutecoin/?utm_source=widget)
inso's avatar
inso committed
========

Moul's avatar
Moul committed
Qt Client for [uCoin](http://www.ucoin.io) project.


## Goal features
  * Ucoin account management via wallets and communities
  * Multi-currency
  * Multi-community
  * Multi-wallets
inso's avatar
inso committed
  * Contacts management
  * User-friendly money transfer
  * Community membership management

## Current state
### Done (master branch)
  * Accounts management
  * Communities viewing
inso's avatar
inso committed
  * Money Transfer
inso's avatar
inso committed
  * cx_freeze deployment
inso's avatar
inso committed
  * Wallets management
inso's avatar
inso committed
  * Contacts management
inso's avatar
inso committed
  * Joining a community, publishing keys
  * Multiple wallets management
inso's avatar
inso committed
### How to build
  * __git clone --recursive https://github.com/ucoin-io/cutecoin.git__
  * Dependencies :
   * [python3](https://www.python.org/downloads/)
   * [cx_freeze for python 3](http://cx-freeze.sourceforge.net/)
   * [pyqt5](http://www.riverbankcomputing.co.uk/software/pyqt/download5)
   * [libsodium](http://doc.libsodium.org/installation/README.html)
  * To get python libraries dependencies :
inso's avatar
inso committed
   * __pip install pylibscrypt__
   * __pip install libnacl__
inso's avatar
inso committed
   * __pip install requests__
inso's avatar
inso committed
   * __pip install base58__
  * Run __python3 gen_resources.py__ in cutecoin folder
  * Run __python3 gen_translations.py__ in cutecoin folder
  * Run __python3 setup.py build__ in cutecoin folder
inso's avatar
inso committed
  * The executable is generated in "build" folder, named "cutecoin"

Moul's avatar
Moul committed
### Download latest release
  * Go to [current release](https://github.com/ucoin-io/cutecoin/release)
  * Download corresponding package to your operating system
inso's avatar
inso committed
  * Unzip and start "cutecoin" :)
Moul's avatar
Moul committed
  * Join our beta community by contacting us on [uCoin forum](http://forum.ucoin.io/)
Moul's avatar
Moul committed

## License
This software is distributed under [GNU GPLv3](https://raw.github.com/ucoin-io/cutecoin/dev/LICENSE).