build instructions style update

This commit is contained in:
Micah Lee 2014-06-24 14:37:13 -04:00
parent f54dfaaf26
commit 756fc99d3c

View file

@ -4,22 +4,28 @@
Start by getting a copy of the source code: Start by getting a copy of the source code:
git clone https://github.com/micahflee/onionshare.git ```sh
cd onionshare git clone https://github.com/micahflee/onionshare.git
cd onionshare
```
*For .deb-based distros (like Debian, Ubuntu, Linux Mint):* *For .deb-based distros (like Debian, Ubuntu, Linux Mint):*
Note that python-stem appears in Debian wheezy and newer (so by extension Tails 1.1 and newer), and it appears in Ubuntu 13.10 and newer. Older versions of Debian and Ubuntu aren't supported. Note that python-stem appears in Debian wheezy and newer (so by extension Tails 1.1 and newer), and it appears in Ubuntu 13.10 and newer. Older versions of Debian and Ubuntu aren't supported.
sudo apt-get install -y build-essential fakeroot python-all python-stdeb python-flask python-stem python-qt4 ```sh
./build_deb.sh sudo apt-get install -y build-essential fakeroot python-all python-stdeb python-flask python-stem python-qt4
sudo dpkg -i deb_dist/onionshare_*.deb ./build_deb.sh
sudo dpkg -i deb_dist/onionshare_*.deb
```
*For .rpm-based distros (Red Hat, Fedora, CentOS):* *For .rpm-based distros (Red Hat, Fedora, CentOS):*
sudo yum install -y rpm-build python-flask python-stem pyqt4 ```sh
./build_rpm.sh sudo yum install -y rpm-build python-flask python-stem pyqt4
sudo yum install -y dist/onionshare-*.rpm ./build_rpm.sh
sudo yum install -y dist/onionshare-*.rpm
```
## Mac OS X ## Mac OS X
@ -27,25 +33,31 @@ To install the right dependencies, you need homebrew and pip installed on your M
The first time you're setting up your dev environment: The first time you're setting up your dev environment:
git clone https://github.com/micahflee/onionshare.git ```sh
cd onionshare git clone https://github.com/micahflee/onionshare.git
echo export PYTHONPATH=\$PYTHONPATH:/usr/local/lib/python2.7/site-packages/ >> ~/.profile cd onionshare
source ~/.profile echo export PYTHONPATH=\$PYTHONPATH:/usr/local/lib/python2.7/site-packages/ >> ~/.profile
brew install qt4 pyqt source ~/.profile
sudo pip install virtualenv brew install qt4 pyqt
virtualenv env sudo pip install virtualenv
. env/bin/activate virtualenv env
pip install flask stem py2app . env/bin/activate
# fixes a silly bug https://bitbucket.org/ronaldoussoren/py2app/issue/143/resulting-app-mistakenly-looks-for-pyside pip install flask stem py2app
patch env/lib/python2.7/site-packages/py2app/util.py < setup/py2app.patch # fixes a silly bug https://bitbucket.org/ronaldoussoren/py2app/issue/143/resulting-app-mistakenly-looks-for-pyside
patch env/lib/python2.7/site-packages/py2app/util.py < setup/py2app.patch
```
Each time you start work: Each time you start work:
. env/bin/activate ```sh
. env/bin/activate
```
Build the .app: Build the .app:
python setup.py py2app ```sh
python setup.py py2app
```
Now you should have `dist/OnionShare.app`. Now you should have `dist/OnionShare.app`.
@ -70,8 +82,12 @@ To make an exe:
OnionShare includes [nose](https://nose.readthedocs.org/en/latest/) unit tests. First, OnionShare includes [nose](https://nose.readthedocs.org/en/latest/) unit tests. First,
sudo pip install nose ```sh
sudo pip install nose
```
To run the tests: To run the tests:
nosetests test ```sh
nosetests test
```