Merge pull request #550 from colkito/fix/update-readme-dev
updated README with development details
This commit is contained in:
commit
2cb9925277
3 changed files with 41 additions and 3 deletions
38
README.md
38
README.md
|
|
@ -67,6 +67,44 @@ Default configuration can be found in the config.js file.
|
||||||
See config.js for more info on configuration options.
|
See config.js for more info on configuration options.
|
||||||
|
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
## Google Chrome Extension
|
||||||
|
When you need to compile a *Chrome Extension* of Copay, you only need to run:
|
||||||
|
```
|
||||||
|
$ sh chrome/build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
- The ZIP file is *chrome/copay-chrome-extension.zip*
|
||||||
|
|
||||||
|
## Firefox Add-on
|
||||||
|
System Requirements
|
||||||
|
|
||||||
|
* Download [Add-on SDK](https://addons.mozilla.org/en-US/developers/builder)
|
||||||
|
* Install it. [Mozilla Docs](https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation)
|
||||||
|
|
||||||
|
Run
|
||||||
|
|
||||||
|
```
|
||||||
|
$ sh firefox/build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
- Copy the content of *firefox/firefox-addon* (lib, data, package.json) to your development path.
|
||||||
|
- Compile the XPI file. [Mozilla Docs](https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_started)
|
||||||
|
|
||||||
|
##Web App
|
||||||
|
The Web App is a clean version of Copay, only the neededs files (html, css, js)
|
||||||
|
for run Copay locally or in your own server.
|
||||||
|
|
||||||
|
In order to get the ZIP file of Copay, you just need to run:
|
||||||
|
```
|
||||||
|
$ sh webapp/build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
- The ZIP file is *webapp/download/copay.zip*
|
||||||
|
- The *webapp/copay-webapp* is the unzipped version
|
||||||
|
|
||||||
|
|
||||||
# About Copay
|
# About Copay
|
||||||
|
|
||||||
General
|
General
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
System Requirements
|
Development
|
||||||
|
|
||||||
* Just run:
|
* Just run:
|
||||||
|
|
||||||
|
|
@ -6,4 +6,4 @@ System Requirements
|
||||||
$ sh chrome/build.sh
|
$ sh chrome/build.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
* The copay-chrome-extension.zip is into ./chrome folder
|
* The ZIP file is *chrome/copay-chrome-extension.zip*
|
||||||
|
|
|
||||||
|
|
@ -9,5 +9,5 @@ Run
|
||||||
$ sh firefox/build.sh
|
$ sh firefox/build.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
- Copy the content of firefox/firefox-addon (lib, data, package.json) to your development path.
|
- Copy the content of *firefox/firefox-addon* (lib, data, package.json) to your development path.
|
||||||
- Compile the XPI file [Mozilla Docs](https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_started)
|
- Compile the XPI file [Mozilla Docs](https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_started)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue