Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RadhiFadlillah committed Feb 4, 2019
1 parent 1072549 commit 77b1a45
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,23 @@ Qamel

[![GoDoc](https://godoc.org/github.com/RadhiFadlillah/qamel?status.png)](https://godoc.org/github.com/RadhiFadlillah/qamel)
[![Donate](https://img.shields.io/badge/donate-PayPal-green.svg)](https://www.paypal.me/RadhiFadlillah)
[![Docker](https://img.shields.io/badge/docker-qamel-blue.svg)](https://hub.docker.com/r/radhifadlillah/qamel)


Qamel is a simple QML binding for Go, heavily inspired by [`therecipe/qt`](https://github.com/therecipe/qt). This package only binds Qt's classes that used for creating a simple QML app, i.e. `QApplication`, `QQuickView` and `QQMLApplicationEngine`. It's still work-in progress, however it should be stable enough to use in production (as in I'm already using it in prod without problem, your situations may vary).

### Features

- Published under MIT License, which means you can use this binding for whatever you want.
- Since it only binds the small set of Qt's class, the build time is quite fast.
- It's available as Docker image, which means you can create QML app without installing Qt in your PC. Go is still needed though.
- The binding itself is really simple and small. I also think I did a good job on commenting my code, so people should be able to fork it easily.

### Limitation

- I've only tested this in Linux and Windows, so I can't vouch for other OS. It should works though, since the code itself is really simple.
- I've only tested this in Linux and Windows, so I'm not sure about Mac OS. It should works though, since the code itself is really simple.
- When declaring custom QML object, this binding only [supports](https://github.com/RadhiFadlillah/qamel/wiki/QmlObject-Documentation) basic data type, i.e. `int`, `int32`, `int64`, `float32`, `float64`, `bool` and `string`. For other data type like struct, array or map, you have to use `string` type and pass it as JSON value.
- Thanks to Go and Qt, in theory, the app built using this binding can be cross compiled from and to Windows, Linux and MacOS. However, since I only have Linux PC, I only able to test cross compiling from Linux to Windows.
- Thanks to Go and Qt, in theory, the app built using this binding can be cross compiled from and to Windows, Linux and MacOS. However, since I only have Linux and Windows PC, I only able to test cross compiling between Linux and Windows.

### Development Status

Expand All @@ -26,14 +29,14 @@ However, since I created it for the sake of the job, if the issues are not criti

### Resources

All documentation for this binding is available in [wiki](https://github.com/RadhiFadlillah/qamel/wiki) and [GoDoc](https://godoc.org/github.com/RadhiFadlillah/qamel). There are some important sections in wiki that we recommend you to check before you start developing your QML app :
All documentation for this binding is available in [wiki](https://github.com/RadhiFadlillah/qamel/wiki) and [GoDoc](https://godoc.org/github.com/RadhiFadlillah/qamel). There are some important sections in wiki that I recommend you to check before you start developing your QML app :

- [Frequently Asked Questions](https://github.com/RadhiFadlillah/qamel/wiki/Frequently-Asked-Questions-(FAQ))
- [Installation](https://github.com/RadhiFadlillah/qamel/wiki/Installation)
- [Getting Started](https://github.com/RadhiFadlillah/qamel/wiki/Getting-Started)
- [CLI Usage](https://github.com/RadhiFadlillah/qamel/wiki/CLI-Usage)
- [Building App](https://github.com/RadhiFadlillah/qamel/wiki/Building-Application)

You might also want to check Qt's documentation about QML :
You might also want to check Qt's official documentation about QML :

- [Qt QML](http://doc.qt.io/qt-5/qtqml-index.html)
- [QML Reference](http://doc.qt.io/qt-5/qmlreference.html)
Expand Down

0 comments on commit 77b1a45

Please sign in to comment.