Skip to content

Commit

Permalink
Release v0.5.0 - Merge branch 'release/v0.5.0'
Browse files Browse the repository at this point in the history
Conflicts:
	lib/tests/test_multisig.py

Finalize 0.5.0 Release with Trezor & Multisig Wallet support
Adds linux universal pyinstaller package w/ installer
  • Loading branch information
guruvan committed Apr 30, 2015
2 parents 7801fd5 + 22b00ec commit 110a4de
Show file tree
Hide file tree
Showing 52 changed files with 1,190 additions and 290 deletions.
9 changes: 5 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
releases/*
source/*.tar.gz
source/tate-*
source/Tate-*
source/encompass-*
source/Encompass-*
.present
repo
repo/*
contrib/encompass-release/repo/*
*.pyc
*.pyd
*.swp
Expand All @@ -17,3 +16,5 @@ contrib/encompass-release/source/Encompas-*
contrib/encompass-release/source/encompas-*
contrib/encompass-release/ltc_scrypt-1.0/
contrib/encompass-release/ltc_scrypt-1.0*
*.pydev*
1
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
### How To Contribute to Encompass

The general workflow process is centered around git-flow & github Pull Requests

1. Fork mazaclub/encompass to your own repo
2. Clone to your local work environment
3. cd into the newly created repo
4. Init gitflow
5. Use gitflow to start a feature
6. complete feature
7. Push feature to your github repo
7. On github create a Pull Request from your feature branch to mazaclub/encompass:develop
8. Please comment on your PR the reason/need for your feature, and provide an example of real-world testing/usage

In general, features should be accompanied by appropriate unit tests.
If your PR is a simple PR it will likely be accepted and merged quickly - if it is more complex,
you are encouraged to join us in #mazaclub to discuss.

# General Development

Use of gitflow recommended, but not required.
All new features should be based off develop branch, not master
Feature PRs should be submitted to develop, not master

# Releases
Releases are made with gitflow, release branches are made from develop approximately every 2weeks
Release branches are merged into master and tagged.

# Bugfixes

With a rapid release cycle, most bugfixes are treated as features, and integrated into the following release.
Non-crucial bugfixes should be integrated as *features* in the next release cycle - please follow feature workflow

Crucial bugfixes are based on master, and primarily developed by committers.

If you have a bugfix that should or must be merged before the next release cycle:
- Demonstrate reproducibility
- Base crucial bugfixes on master
- Submit PR from your bugfix branch via github to mazaclub/encompass:master


2 changes: 1 addition & 1 deletion Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
</array>
<key>LSArchitecturePriority</key>
<array>
<string>i386</string>
<string>x86_64</string>
<string>i386</string>
</array>
</dict>
</plist>
File renamed without changes.
51 changes: 7 additions & 44 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -8,56 +8,19 @@ Contributors: Thomas Voegtlin (Electrum author), mazaclub, pooler, and many more
Language: Python
Homepage: https://maza.club/encompass


1. GETTING STARTED
------------------
First thing you need to do is run:
pyrcc4 icons.qrc -o gui/qt/icons_rc.py

If you do not have pyrcc4 on your system, you may need to install the PyQt4-devel package first.


To run Encompass from this directory, just do:

./encompass

If you install Encompass on your system, you can run it from any
directory:

sudo python setup.py install
encompass


To start Encompass from your web browser, see
http://electrum.org/bitcoin_URIs.html
1. Please see the appropriate README for your OS installation
- README-OSX.md
- README-Windows.md
- README-Ubuntu.md
- README-source.md



2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------

contrib/encompass-release

The 'build' script will perform all the necessary tasks to
create a release from release-tagged github sources

If all runs correctly, you'll find a release set in the
contrib/encompass-release/releases directory, complete with
md5/sha1 sums, and gpg signatures for all files.

Additional documentation is provided in the README in that dir.


### TODO:
On Mac OS X:

# On port based installs
sudo python setup-release.py py2app

# On brew installs
ARCHFLAGS="-arch i386 -arch x86_64" sudo python setup-release.py py2app --includes sip

sudo hdiutil create -fs HFS+ -volname "Encompass" -srcfolder dist/Encompass.app dist/encompass-VERSION-macosx.dmg
See contrib/encompass-release/README.md for complete details on
mazaclub's release process


3. HOW COIN-SPECIFIC MODULES ARE CREATED
Expand Down
35 changes: 35 additions & 0 deletions README-ArchLinux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Encompass - lightweight multi-coin client

Encompass consolidates support for various currencies into one wallet. It is a BIP-0044-compliant multi-currency wallet based on Electrum. This Encompass client uses Electrum servers of supported currencies to retrieve necessary data, so no "Encompass server" is necessary.

Licence: GNU GPL v3
Author: Tyler Willis
Contributors: Thomas Voegtlin (Electrum author), mazaclub, pooler, and many more
Language: Python
Homepage: https://maza.club/encompass

1. ENCOMPASS ON ARCHLINUX
----------------------

* Official Arch Maintainer: Qhor Vertoe
* Official Encompass Arch repo: https://aur.archlinux.org/packages/en/encompass-git/encompass-git.tar.gz
- contrib/ArchLinux contains the most recent contents from the above link ** as of build time **
- ** contrib/ArchLinux may not reflect post-build changes, version updates. **
- you are encouraged to use the official repo, contents are mirrored here for verification
```
wget https://aur.archlinux.org/packages/en/encompass-git/encompass-git.tar.gz \
&& tar -xpzvf encompass-git.tar.gz \
&& cd encompass-git \
&& mkpkg -s \
&& sudo pacman -U encompass-git-$VERSION.pkg.tar.xz
```

2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------

See contrib/encompass-release/README.md for complete details on mazaclub release process

3. HOW COIN-SPECIFIC MODULES ARE CREATED
----------------------------------------

See lib/chains/README.md.
37 changes: 37 additions & 0 deletions README-Linux-x86_64.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Encompass - lightweight multi-coin client

Encompass consolidates support for various currencies into one wallet. It is a BIP-0044-compliant multi-currency wallet based on Electrum. This Encompass client uses Electrum servers of supported currencies to retrieve necessary data, so no "Encompass server" is necessary.

Homepage: https://maza.club/encompass

1. ENCOMPASS ON LINUX
----------------------

- Installer package is provided at https://maza.club/encompass
- To download and use:
```
cd ~
wget https://github.com/mazaclub/encompass/releases/v0.5.0/Encompass-0.5.0-Linux_x86_64.tgz
tar -xpzvf Encompass-0.5.0-Linux_x86_64.tgz
cd Encompass-0.5.0
./encompass_x86_64.bin
```


Once successfully installed simply type
```
encompass
```
Your wallets will be located in /home/YOUR_LOGIN_NAME/.encompass/wallets

Installation on 32bit machines is best achieved via github master or TAGGED branches

2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------

See contrib/encompass-release/README.md for complete details on mazaclub release process

3. HOW COIN-SPECIFIC MODULES ARE CREATED
----------------------------------------

See lib/chains/README.md.
45 changes: 45 additions & 0 deletions README-OSX.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
### Encompass - lightweight multi-coin client

Encompass consolidates support for various currencies into one wallet. It is a BIP-0044-compliant multi-currency wallet based on Electrum. This Encompass client uses Electrum servers of supported currencies to retrieve necessary data, so no "Encompass server" is necessary.

Homepage: https://maza.club/encompass
## Encompass on OSX

1. Download the .dmg from https://maza.club/encompass
2. Open .dmg in Finder
3. Double Click Encompass.pkg
4. Follow instructions to install Encompass

Encompass will be installed by default to /Applications

Your Wallets will be stored in /Users/YOUR_LOGIN_NAME/.encompass/wallets

### KNOWN ISSUES
1. Certain dialog boxes fail to open in the foreground
** Click the Encompass Icon in the Dock to bring correct window to top **



2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------

contrib/encompass-release


The 'build' script will perform all the necessary tasks to
create a release from release-tagged github sources

If all runs correctly, you''ll find a release set in the
contrib/encompass-release/releases directory, complete with
md5/sha1 sums, and gpg signatures for all files.

Additional documentation is provided in the README in that dir.
Official Releases are created with a single OSX machine, boot2docker vm and docker




3. HOW COIN-SPECIFIC MODULES ARE CREATED
----------------------------------------

See lib/chains/README.md.
26 changes: 26 additions & 0 deletions README-Windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Encompass - lightweight multi-coin client

Encompass consolidates support for various currencies into one wallet. It is a BIP-0044-compliant multi-currency wallet based on Electrum. This Encompass client uses Electrum servers of supported currencies to retrieve necessary data, so no "Encompass server" is necessary.

Homepage: https://maza.club/encompass

1. ENCOMPASS ON WINDOWS
-----------------------

- Simply download the provided Encompass-0.5.0-setup.exe and run

Your Wallet files will be in one of the following places, based on the version of Windows installed:
- C:\Users\YOUR_LOGIN_NAME\Application Data\Encompass\wallets
-



2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------

See contrib/encompass-release/README.md

3. HOW COIN-SPECIFIC MODULES ARE CREATED
----------------------------------------

See lib/chains/README.md.
95 changes: 95 additions & 0 deletions README-source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
Encompass - lightweight multi-coin client

Encompass consolidates support for various currencies into one wallet. It is a BIP-0044-compliant multi-currency wallet based on Electrum. This Encompass client uses Electrum servers of supported currencies to retrieve necessary data, so no "Encompass server" is necessary.

Homepage: https://maza.club/encompass

## Operation and Installation from Source
* Most users are encouraged to run provided release packages for their system
* Installation from source requires python knowledge, and knowledge of package managers on your system
* Non-Developers wishing to compile & install from source are encouraged to use the provided build system
instructions are in contrib/encompass-release/README.md

1. GETTING STARTED
------------------

Dependencies:
- pyqt4
- pip
- modules listed in requirements.txt

pyqt4 must be installed by your system package manager.
pip is recommended for python module dependencies installation,

* Windows
- TODO
* OSX
- we recommend macports for installing/building Encompass
```
sudo port install py27-pyqt4
sudo port install py27-pip
```
* Linux
- Ubuntu
```
sudo apt-get update
sudo apt-get install -y python-dev python-qt4 pyqt4-dev-tools python-pip
```


Use pip to install all dependencies:
```
pip install --upgrade -r requirements.txt
```
- OSX users please note, brew, macports, and Apple each install their own python interpreters,
ensure that you use the correct version of pip. For macports this is usually in /opt/local/bin/pip-2.7

Use pyrcc4 to build the icons:
```
pyrcc4 icons.qrc -o gui/qt/icons_rc.py
```
If you do not have pyrcc4 on your system, you may need to install the PyQt4-devel or pyqt4-dev-tools package first.


Then to run Encompass from the source directory:
```
./encompass
```
You can view additional debugging messages with:
```
./encompass -v
```

If you wish to install Encompass on your system, you can run it from any
directory:
```
sudo python setup.py install
encompass
```
Installation from source on Linux is straightforward.
Installation from source on Windows is possible, but not actively supported
Installation from source on OSX is possible, users should modify ./encompass to point
to the correct python installation (i.e. macports) before installation

OSX users will likely find it easiest to build Encompass.app, and run that.
on macports:
```
/opt/local/bin/python2.7 setup.py py2app
```
Resulting Encompass.app is found in the dist/ directory.


To start Encompass from your web browser, see
http://electrum.org/bitcoin_URIs.html



2. HOW OFFICIAL PACKAGES ARE CREATED
------------------------------------

See contrib/encompass-release/README.md

3. HOW COIN-SPECIFIC MODULES ARE CREATED
----------------------------------------

See lib/chains/README.md.
Loading

0 comments on commit 110a4de

Please sign in to comment.