copay/TODO.md

59 lines
1.6 KiB
Markdown
Raw Normal View History

2014-07-08 06:18:53 -07:00
## Running in the Native Shell
Copay can be executed from within a "native" application shell, providing some
additional features such as native menus, notifications, tray integration, etc.
This is accomplished using [Atom Shell](https://github.com/atom/atom-shell).
To run and test Copay from within this context, first download the atom-shell
package to `shell/bin/{platform}` (ignored by git), by running:
```
npm run setup-shell
```
Once this script has completed, you can launch the shell-based Copay by running:
```
npm run shell
```
## Building Native Shell Binaries/Installers (OSX)
```
npm run dist
```
This script will download atom shell binaries and combine them with Copay sources
to build a DMG for osx-x64, an installer EXE for win32, and a .tar.gz for linux-x64.
It was developed to be run on OSX. The outputs are copied to the dist directory.
DMG is created with hdiutil
EXE is created with makensis (brew install makensis)
2014-07-08 06:26:33 -07:00
## Android APK
System Requirements
* Download [Android SDK](http://developer.android.com/sdk/index.html)
* Download and install [Crosswalk](https://crosswalk-project.org/#documentation/getting_started) (Use Linux setup for OSX)
Add to your ~/.bash_profile or ~/.bashrc
```
export CROSSWALK="<path to Crosswalk directory>"
```
To build the APK run the script:
```
sh android/build.sh [-d]
```
- The -d flag will package the apk in debug mode, allowing [remote debugging chrome](https://developer.chrome.com/devtools/docs/remote-debugging)
- The APK file is in **android/Copay_VERSION_arm.apk**
To install the APK in your device run:
```
adb install -r Copay_VERSION_arm.apk
```