Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve README, update LICENSE, add a CONTRIBUTING
This commit adds some more information to the README file, updates the Copyright year in the LICENSE and adds a CONTRIBUTING file, to give some hints, how to contribute.
- Loading branch information
1 parent
44bea45
commit c42386b
Showing
3 changed files
with
71 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| QmlWeb is a KDE project. | ||
|
|
||
| That means you can contribute like you do to any KDE project: | ||
|
|
||
| - Report bugs on https://bugs.kde.org/enter_bug.cgi?product=QmlWeb | ||
| - Send patches to https://reviewboard.kde.org/r/new/ | ||
|
|
||
| If you have made a few commits and wish to contribute more actively, | ||
| please apply for a KDE contributor account: | ||
| https://techbase.kde.org/Contribute/Get_a_Contributor_Account. | ||
|
|
||
|
|
||
| Alternatively, if you insist on it, you may fill a pull-request on | ||
| GitHub (https://github.com/akreuzkamp/qmlweb). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,55 @@ | ||
| Prototype of QML engine in a web browser. | ||
| == A QML engine in a web browser == | ||
|
|
||
| The QML language is well-suited for building web applications. Goal is | ||
| to develop the required technologies for that. This is a runtime | ||
| environment in JavaScript and the required QML modules to render in | ||
| web browsers. Other applications can be considered. Main focus is on | ||
| developing hybrid-applications using native (Qt) and web technologies | ||
| of any scale, not forgetting the creation of sole web applications. | ||
| QmlWeb is not intended to run native QtQuick applications using QmlWeb | ||
| without migration effort. | ||
|
|
||
| === Get started === | ||
|
|
||
| To use QmlWeb, you need a simple html file to load and start QmlWeb. | ||
| This simple file will do: | ||
|
|
||
| ` | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>QmlWeb Demo</title> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | ||
| <script type="text/javascript" src="../qmlweb/src/parser.js"></script> | ||
| <script type="text/javascript" src="../qmlweb/src/import.js"></script> | ||
| <script type="text/javascript" src="../qmlweb/src/qtcore.js"></script> | ||
| </head> | ||
| <body style="margin: 0;"> | ||
| <script type="text/javascript"> | ||
| var qmlEngine = new QMLEngine(); | ||
| qmlEngine.loadFile("main.qml"); | ||
| qmlEngine.start(); | ||
| </script> | ||
| </body> | ||
| </html> | ||
| ` | ||
|
|
||
| The next thing you need is a QML-file: | ||
|
|
||
| ` | ||
| import QtQuick 1.1 | ||
|
|
||
| Item { | ||
|
|
||
| Text { | ||
| anchors.centerIn: parent | ||
| text: "Hello World!" | ||
| font.pointSize: 12 | ||
| color: grey | ||
| } | ||
|
|
||
| } | ||
| ` | ||
|
|
||
| That's it. | ||
| _Hint: To get the root Item fill the whole screen, just don't set it's size._ |