Skip to content

Commit

Permalink
Merge branch 'release/0.3.0-rc'
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesus89 committed Mar 29, 2017
2 parents 74396cf + 909bbb9 commit 39a7aba
Show file tree
Hide file tree
Showing 126 changed files with 7,183 additions and 9,722 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ cache
node_modules
bower_components

**/locale/**/*.json
app/resources/collection
app/resources/locale/**/*.json
File renamed without changes.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ deploy:
- dist/*.zip
- dist/*.dmg
- dist/*.exe
- dist/*.AppImage
file_glob: true
skip_cleanup: true
on:
Expand Down
119 changes: 48 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,58 @@
<img src="./doc/images/icestudio-logo-label.png" align="center">

[![Build Status](https://travis-ci.org/FPGAwars/icestudio.svg?branch=0.3.0-rc)](https://travis-ci.org/FPGAwars/icestudio)
[![Version](https://img.shields.io/badge/version-v0.3.0--rc-orange.svg)](https://github.com/FPGAwars/icestudio/releases)
[![License](http://img.shields.io/:license-gpl-blue.svg)](http://opensource.org/licenses/GPL-2.0)
[![Documentation Status](https://readthedocs.org/projects/icestudio/badge/?version=latest)](http://icestudio.readthedocs.io/en/latest)
[![Documentation Status](https://readthedocs.org/projects/icestudio/badge/?version=stable)](http://icestudio.readthedocs.io/en/stable)


**Experimental** graphic editor for open FPGAs. Built on top of the [icestorm project](http://www.clifford.at/icestorm/).
**Experimental** graphic editor for open FPGAs. Built on top of the [Icestorm project](http://www.clifford.at/icestorm/).

GUI -> JSON -> Verilog, PCF

Supported boards:

* [IceZUM Alhambra](https://github.com/FPGAwars/icezum)
* [Kéfir I iCE40-HX4K](http://fpgalibre.sourceforge.net/Kefir/)
* [Nandland Go board](https://www.nandland.com/goboard/introduction.html)
* [iCEstick](http://www.pighixxx.com/test/portfolio-items/icestick/)
* [iCE40-HX8K](http://www.latticesemi.com/Products/DevelopmentBoardsAndKits/iCE40HX8KBreakoutBoard.aspx)
* [iCE40-HX8K Breakout Board](http://www.latticesemi.com/Products/DevelopmentBoardsAndKits/iCE40HX8KBreakoutBoard.aspx)
* [iCEstick Evaluation Kit](http://www.pighixxx.com/test/portfolio-items/icestick/)
* [icoBOARD 1.0](http://icoboard.org/about-icoboard.html)
* [Kéfir I](http://fpgalibre.sourceforge.net/Kefir/)

Supported operating systems:

* GNU/Linux
* Windows
* Mac OS X

## Version 0.3.0-beta3 (latest)

Documentation: http://icestudio.readthedocs.io/en/latest

### Installation
## Installation

* **GNU/Linux**

1. Install [Python 2.7](https://www.python.org)
2. Download the [zipped release](https://github.com/FPGAwars/icestudio/releases/tag/0.3.0-beta3), unzip and execute **icestudio**


NOTE: GNU/Linux users must have **xclip** installed to enable Copy/Paste.
1. Install [Python 2.7](https://www.python.org) and **xclip**
2. Download and execute the [AppImage](https://github.com/FPGAwars/icestudio/releases)


* **Windows**

1. Download and execute the [Windows installer](https://github.com/FPGAwars/icestudio/releases/tag/0.3.0-beta3)
1. Download and execute the [Windows installer](https://github.com/FPGAwars/icestudio/releases)


* **Mac OS X**

1. Install [Python 2.7](https://www.python.org)
2. Download and execute the [DMG package](https://github.com/FPGAwars/icestudio/releases/tag/0.3.0-beta3)
2. Download and execute the [DMG package](https://github.com/FPGAwars/icestudio/releases)

<img src="./doc/images/main.png" width="700" align="center">

<img src="./doc/images/icestudio-0.3.0-beta3.png" width="700" align="center">
Check the [Documentation](http://icestudio.readthedocs.io/en/latest) for more information.

## Development

Install [Python 2.7](https://www.python.org/downloads/release/python-2711/) and [nodejs](https://github.com/nodejs/node).

Using [Atom](https://atom.io/) editor with [linter-jshint](https://atom.io/packages/linter-jshint).
[Atom](https://atom.io/) editor with [linter-jshint](https://atom.io/packages/linter-jshint) is recommended.

NOTE: if you want to add blocks or examples, please contribute to [icestudio-blocks](https://github.com/FPGAwars/icestudio-blocks) or [icestudio-examples](https://github.com/FPGAwars/icestudio-examples).
If you want to add blocks or examples, please contribute to [icestudio-blocks](https://github.com/FPGAwars/icestudio-blocks), [icestudio-examples](https://github.com/FPGAwars/icestudio-examples) or [collection-default](https://github.com/FPGAwars/collection-default).


##### Ubuntu
Expand Down Expand Up @@ -92,25 +87,29 @@ npm start
npm run dist
```

Output
* *GNU/Linux*: linux32.zip, linux64.zip, win32.zip, win64.zip, win32.exe, win64.exe.
* *Mac OS X*: osx32.zip, osx64.zip, osx64.dmg.
| OS | Development OS | Output files |
|:---:|:-------------:|:-----------------:|
| GNU/Linux | GNU/Linux | (linux32,linux64).zip, (linux32,linux64).AppImage |
| Windows | GNU/Linux | (win32,win64).zip, (win32,win64).exe |
| Mac OS X | Mac OS X | (osx32,osx64).zip, osx64.dmg |


## Languages

| Language | Translated strings |
|:----------:|:------------------------------------------:|
| English | ![Progress](http://progressed.io/bar/100) |
| Spanish | ![Progress](http://progressed.io/bar/100) |
| Basque | ![Progress](http://progressed.io/bar/87) |
| French | ![Progress](http://progressed.io/bar/61) |
| Galician | ![Progress](http://progressed.io/bar/35) |
| Galician | ![Progress](http://progressed.io/bar/95) |
| Basque | ![Progress](http://progressed.io/bar/95) |
| Catalan | ![Progress](http://progressed.io/bar/95) |
| French | ![Progress](http://progressed.io/bar/95) |

**Contribute**: add or update the [translations](https://github.com/FPGAwars/icestudio/tree/develop/app/resources/locale) by following the [next instructions](https://angular-gettext.rocketeer.be/dev-guide/translate/#poedit).
**Contribute!**

```bash
npm run gettext
```
Add or update the [app translations](https://github.com/FPGAwars/icestudio/tree/develop/app/resources/locale) using **[Poedit](https://poedit.net/)**.

*Developer note*: use `npm run gettext` to extract the labels from the code.

## Troubleshooting

Expand All @@ -128,22 +127,6 @@ There is a [Wishlist](https://github.com/FPGAwars/icestudio/wiki/Wishlist:-propo

We use the GitHub issues to schedule our new features and improvements.

## Version 0.2.3 (stable)

### Installation

1. Install [Python 2.7](https://www.python.org)

2. Download the [release](https://github.com/FPGAwars/icestudio/releases/tag/0.2.3), unzip and execute **icestudio**

Documentation: http://icestudio.readthedocs.io/en/stable

<img src="./doc/images/icestudio-0.2.3.png" width="700" align="center">

## Version 0.1

![][icestudio-0.1-demo]

## Videos

### Version 0.2
Expand All @@ -154,46 +137,40 @@ Documentation: http://icestudio.readthedocs.io/en/stable

[![Icestudio: block factory](http://img.youtube.com/vi/mAIKb47z2Do/0.jpg)](http://www.youtube.com/watch?v=mAIKb47z2Do "Icestudio: block factory")


### Version 0.1

[![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 Torrens](https://github.com/Jesus89)

## Contributors

* v0.3
* [Martoni](https://github.com/Martoni)
* [Carlos Díaz](https://github.com/C47D)
* [Lorea-Aldabaldetreku](https://github.com/Lorea-Aldabaldetreku)

* [Lorea-Aldabaldetreku](https://github.com/Lorea-Aldabaldetreku)
* [Carlos Díaz](https://github.com/C47D)
* [Martoni](https://github.com/Martoni)
* [Xoan Sampaiño](https://github.com/xoan)
* [Unai](https://github.com/1138-4EB)
* [Francisco Sayas](https://github.com/fsayas)
* [Pascal Cotret](https://github.com/pcotret)
* v0.2
* [Tomás Calvo](https://github.com/tocalvo)
* [Juan González (Obijuan)](https://github.com/Obijuan)
* [Carlos Díaz](https://github.com/C47D)
* [Xoan Sampaiño](https://github.com/xoan)
* [Salvador E. Tropea](https://github.com/set-soft)
* [Democrito](https://github.com/Democrito)
* [Martoni](https://github.com/Martoni)
* [Pascal Cotret](https://github.com/pcotret)
* [Tomás Calvo](https://github.com/tocalvo)
* [Juan González (Obijuan)](https://github.com/Obijuan)
* [Carlos Díaz](https://github.com/C47D)
* [Xoan Sampaiño](https://github.com/xoan)
* [Salvador E. Tropea](https://github.com/set-soft)
* [Democrito](https://github.com/Democrito)
* [Martoni](https://github.com/Martoni)
* [Pascal Cotret](https://github.com/pcotret)
* v0.1
* [Miguel Sánchez de León Peque](https://github.com/Peque)
* [Miguel Sánchez de León Peque](https://github.com/Peque)

## Credits

* v0.3, v0.2: using [JointJS](https://github.com/clientIO/joint) and [AlertifyJS](https://github.com/MohammadYounes/AlertifyJS)
* v0.1: using [AngularJS-Flowchart](https://github.com/codecapers/AngularJS-FlowChart)
* Sponsored by [BQ](https://www.bq.com)
* [BQ](https://www.bq.com) sponsored this project from 02-2016 to 02-2017. Thanks

![](https://github.com/FPGAwars/icezum/raw/master/wiki/bq-logo.png)

## License

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-0.1-demo]: doc/images/icestudio-demo.gif
Licensed under [GPL 2.0](http://opensource.org/licenses/GPL-2.0) and [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).
2 changes: 1 addition & 1 deletion app/bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@
"svg-pan-zoom": "^3.2.9",
"alertify-js": "^1.8.0",
"jquery-resize": "*",
"angular-gettext": "^2.3.8"
"angular-gettext": "https://github.com/Jesus89/angular-gettext.git#master"
}
}
5 changes: 3 additions & 2 deletions app/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
<!-- endbower -->
<!-- endbuild -->
<!-- build:css styles/main.css -->
<link rel="stylesheet" href="styles/design.css">
<link rel="stylesheet" href="styles/main.css">
<link rel="stylesheet" href="styles/menu.css">
<link rel="stylesheet" href="styles/design.css">
<!-- endbuild -->
</head>

Expand Down Expand Up @@ -65,10 +65,11 @@
<script src="scripts/services/boards.js"></script>
<script src="scripts/services/common.js"></script>
<script src="scripts/services/compiler.js"></script>
<script src="scripts/services/drivers.js"></script>
<script src="scripts/services/graph.js"></script>
<script src="scripts/services/profile.js"></script>
<script src="scripts/services/project.js"></script>
<script src="scripts/services/resources.js"></script>
<script src="scripts/services/collections.js"></script>
<script src="scripts/services/shortcuts.js"></script>
<script src="scripts/services/tools.js"></script>
<script src="scripts/services/utils.js"></script>
Expand Down
9 changes: 5 additions & 4 deletions app/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "icestudio",
"version": "0.3.0-beta3",
"version": "0.3.0-rc",
"description": "Experimental graphic editor for open FPGAs",
"author": "Jesús Arroyo Torrens <jesus.jkhlg@gmail.com>",
"repository": "https://github.com/FPGAwars/icestudio",
Expand All @@ -18,8 +18,8 @@
"icon": "resources/images/icestudio-logo.png"
},
"apio": {
"min": "0.2.1.2",
"max": "0.2.2"
"min": "0.2.2",
"max": "0.2.3"
},
"engines": {
"node": ">= 0.10.0"
Expand All @@ -29,6 +29,7 @@
"angular-gettext-tools": "~2.3.3",
"copy-paste": "^1.3.0",
"fs-extra": "^1.0.0",
"getos": "^2.8.4",
"glob": "^7.1.1",
"is-online": "^5.2.0",
"jquery": "^3.1.1",
Expand All @@ -40,7 +41,7 @@
"sha1": "^1.1.1",
"ssh-exec": "^2.0.0",
"sudo-prompt": "^6.2.0",
"svgo": "^0.7.1",
"svgo": "~0.7.1",
"tarball-extract": "0.0.3"
},
"readme": "../README.md",
Expand Down
2 changes: 1 addition & 1 deletion app/resources/boards/go-board/info.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Go board",
"label": "Nandland Go board",
"datasheet": "https://www.nandland.com/goboard/introduction.html"
}
2 changes: 1 addition & 1 deletion app/resources/boards/iCE40-HX8K/info.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "iCE40-HX8K",
"label": "iCE40-HX8K Breakout Board",
"datasheet": "http://www.latticesemi.com/view_document?document_id=50373"
}
Loading

0 comments on commit 39a7aba

Please sign in to comment.