Added initial documentation for installation

This commit is contained in:
Cameron Conn 2013-08-01 14:08:45 -05:00
parent fde0739652
commit 450f6d7509

INSTALL Normal file
View File

@ -0,0 +1,101 @@
#PyBitmessage Installation Instructions
For an up-to-date version of these instructions, please visit the
[Bitmessage Wiki](
PyBitmessage can be run either straight from source or from an installed
Before running PyBitmessage, make sure you have all the needed dependencies
installed on your system.
Here's a list of dependencies needed for PyBitmessage
- python2.7
- python2-qt4 (python-qt4 on Debian/Ubuntu)
- openssl
- (Fedora & Redhat only) openssl-compat-bitcoin-libs
##Running PyBitmessage
PyBitmessage can be run two ways: straight from source or via a package which
is installed on your system. Since PyBitmessage is Beta, it is best to run
PyBitmessage from source, so that you may update as needed.
To update PyBitmessage from source (Linux/OS X), you can do these easy steps:
cd PyBitmessage/src/
git fetch --all
git reset --hard origin/master
Viola! Bitmessage is updated!
To run PyBitmessage from the command-line, you must download the source, then
run `src/`.
git clone git://
cd PyBitmessage/ && python src/
That's it! *Honestly*!
In Windows you can download an executable for Bitmessage
However, if you would like to run PyBitmessage via Python in Windows, you can
go [here]( for
information on how to do so.
####OS X
First off, install Homebrew.
ruby -e "$(curl -fsSL"
Now, install the required dependencies
sudo port install python27 py27-pyqt4 openssl
sudo port install git-core +svn +doc +bash_completion +gitweb
Download and run PyBitmessage:
git clone git://
cd PyBitmessage && python src/
##Creating a package for installation
If you really want, you can make a package for PyBitmessage which you may
install yourself or distribute to friends. This isn't reccomended, since
PyBitmessage is in Beta, and subject to frequent change.
First off, since PyBitmessage uses something nifty called
[packagemonkey](, go ahead and get
that installed. You may have to build it from source.
Next, edit the script. To your liking.
Now, run the appropriate script for the type of package you'd like to make
``` - create a package for Arch Linux - create a package for Debian/Ubuntu - create a package for Gentoo - create a package for OS X - create a package for Puppy Linux - create a RPM package - create a package for Slackware
####OS X
Please refer to
[this page](,2761.0.html) on the
forums for instructions on how to create a package on OS X.
Please note that some versions of OS X don't work.
#TODO: Create Windows package creation instructions