Merge branch 'develop'

.gitignore

@@ -1,5 +1,8 @@
-.pioenvs
+*.sconsign.dblite
+file
 *.out
 *.asc
 *.bin
 *.blif
+*.pyc
+build

README.md

@@ -3,42 +3,90 @@
 [![R&D](https://img.shields.io/badge/-R%26D-brightgreen.svg)](https://github.com/Jesus89/icestudio)
 [![License](http://img.shields.io/:license-gpl-blue.svg)](http://opensource.org/licenses/GPL-2.0)
 
-![][icestudio]
-
-Experimental graphic editor for open FPGAs.
+Experimental graphic editor for open FPGAs. Tested with Linux and [iCEstick board](http://www.pighixxx.com/test/portfolio-items/icestick/). Built on top of [icestorm project](http://www.clifford.at/icestorm/).
 
     GUI -> JSON -> Verilog, PCF
 
-### Install dependencies
+![][icestudio-demo]
 
-Install [platformio](platformio.org)
-```bash
-pip install platformio
-```
+## Installation
+
+1. Install and configure the [drivers](https://github.com/bqlabs/icestudio/wiki/Installing-the-drivers)
 
-Install icestick in platformio: [wiki](https://github.com/bqlabs/Platformio-FPGA/wiki/Platformio-FPGA-wiki-home).
+2. Download the [latest release](https://github.com/bqlabs/icestudio/releases), unpack the zip and execute Icestudio
 
-Install icestorm toolchain in platformio with this [script](https://github.com/bqlabs/Platformio-FPGA/blob/master/build-toolchain.sh).
+NOTE: this is an **early experimental version**. Initially supported on Linux (32, 64), Windows and Mac.
 
-Install nodejs and nwjs
+## Development
+
+Install nodejs
 ```bash
 curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
 sudo apt-get install -y nodejs
-sudo npm install -g nw
+```
+
+Install nwjs
+```bash
+sudo npm install -g [email protected]
+```
+
+Install nw-builder
+```bash
+sudo npm install -g nw-builder
+```
+
+Install the toolchain with [apio](https://github.com/bqlabs/apio#install)
+
+### Download
+
+```bash
+git clone https://github.com/bqlabs/icestudio.git
+cd icestudio
 ```
 
 ### Execute
 
 ```bash
-nw gui
+nw icestudio
+```
+
+### Package
+
+```bash
+nwbuild -p linux64 icestudio -v v0.12.3
+nwbuild -p osx64 icestudio -v v0.12.3
+nwbuild -p win64 icestudio -v v0.12.3
+
+cd build/Icestudio
+
+zip -r icestudio-linux64 linux64
+zip -r icestudio-osx64 osx64
+zip -r icestudio-win64 win64
 ```
 
-### Authors
+## Videos
+
+[![Icestudio: GUI for open FPGAs](http://img.youtube.com/vi/Okl4Rr_i6Qk/0.jpg)](http://www.youtube.com/watch?v=Okl4Rr_i6Qk "Icestudio: GUI for open FPGAs")
+
+[![Icestudio: code generation](http://img.youtube.com/vi/pG1DsF9MIj0/0.jpg)](http://www.youtube.com/watch?v=pG1DsF9MIj0 "Icestudio: code generation")
+
+## Authors
 
 * Jesús Arroyo
 
-### Credits
+## Contributors
+
+* Miguel Sánchez de León Peque
+
+## Credits
 
 * Using [AngularJS-Flowchart](https://github.com/codecapers/AngularJS-FlowChart)
 
-[icestudio]: doc/icestudio.gif
+## License
+
+![][bq-logo-cc-sa]
+
+Licensed under [GPLv2](http://opensource.org/licenses/GPL-2.0) and [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/)
+
+[icestudio-demo]: doc/images/icestudio-demo.gif
+[bq-logo-cc-sa]: doc/images/bq-logo-cc-sa-small-150px.png