|
| 1 | +# MachinekitSDK |
| 2 | + |
| 3 | +Qt Creator extension for creating [QtQuickVcp](https://github.com/strahlex/QtQuickVcp) |
| 4 | +and [Machinekit](https://github.com/strahlex/machinekit) applications |
| 5 | + |
| 6 | +## Contents |
| 7 | +* <a href="#install">Installing the Machinekit SDK</a> |
| 8 | +* <a href="#use">Using the Machinekit SDK</a> |
| 9 | + |
| 10 | +<a name="install"> |
| 11 | +## Installing the Machinekit SDK |
| 12 | +There are several ways to install the MachinekitSDK. |
| 13 | + |
| 14 | +### Easy way - Vagrant |
| 15 | +The easiest way to get a running MachinekitSDK, QtQuickVcp and Machinekit installation is to use |
| 16 | +the [Vagrant configuration](https://github.com/strahlex/machinekit-vagrant). Follow the steps provided |
| 17 | +in the repository and you will have a working installation with a few clicks. |
| 18 | + |
| 19 | +### Prerequisites |
| 20 | +Before continuing with this guide please install: |
| 21 | + |
| 22 | +* [QtQuickVcp](https://github.com/strahlex/QtQuickVcp) |
| 23 | +* [Machinekit](https://github.com/strahlex/machinekit) |
| 24 | + |
| 25 | +Please follow the project specific steps. |
| 26 | + |
| 27 | +### Clone the Git repository |
| 28 | +Clone the [MachinekitSDK Git repository](https://github.com/strahlex/MachinekitSDK) |
| 29 | + |
| 30 | + git clone https://github.com/strahlex/MachinekitSDK.git |
| 31 | + |
| 32 | +### Install with QtCreator |
| 33 | +* To install the MachinekitSDK using QtCreator open the `MachinekitSDK.pro` project file. |
| 34 | +* Then open the **Projects** register on the left side and add an additional **Build Step > Make**. |
| 35 | +* In the **Make arguments** edit enter `install`. Next hit the build button (Ctrl+Shift+B). |
| 36 | +* Restart QtCreator and you should find the Machinekit register in the **File > New File or Project..** menu. |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +### Install from terminal |
| 41 | +Run the `install.sh` file with the QtSDK dir as argument: |
| 42 | + |
| 43 | +```bash |
| 44 | +./install.sh ~/bin/Qt |
| 45 | +``` |
| 46 | + |
| 47 | +### Setup QtCreator |
| 48 | +After you have built the MachinekitSDK you need to do the following steps (after a restart of QtCreator) in order to enable all the features: |
| 49 | + |
| 50 | +- Enable the Qbs QtCreator plugin |
| 51 | +- *Enable the BBIOConfig QtCreator plugin* - **Note:** this feature is currently disabled |
| 52 | +- Add a remote Linux Target |
| 53 | + |
| 54 | +Watch this video for a tutorial: |
| 55 | + |
| 56 | +[](http://www.youtube.com/watch?v=L-nyk7UUEUU) |
| 57 | +### Optional - BBIOConfig Plugin |
| 58 | +The BBIOConfig plugin has been disabled since plugin infrastructure of |
| 59 | +QtCreator has changed. If you still want to try your luck please follow these instructions: |
| 60 | + |
| 61 | +Download the Qt Creator sources. Replace the **version** with the Qt Creator version you have installed **e.g. v3.1.0** |
| 62 | + |
| 63 | + cd ~/bin |
| 64 | + git clone https://github.com/qtproject/qt-creator.git |
| 65 | + cd qt-creator |
| 66 | + git checkout <version> |
| 67 | + |
| 68 | +Next you have to modify the two paths concerning Qt Creator in the file *paths.pri* inside the QtQuickVcp directory: |
| 69 | + |
| 70 | + QTCREATOR_SOURCE_DIR=<path to Qt Creator source> |
| 71 | + QTCREATOR_INSTALL_DIR=<path to Qt SDK>/Tools/QtCreator/ |
| 72 | + |
| 73 | + |
| 74 | +Build and install the project: |
| 75 | + |
| 76 | +Open the `MachinekitSDK.pro` file in Qt Creator, select the Desktop version of Qt you have installed. Then go the Projects register and add a custom make command `install`. Now you are ready to build the project in Release mode. |
| 77 | + |
| 78 | +<a name="use"> |
| 79 | +# Using the Machinekit SDK |
| 80 | +Please take a look at the following tutorials on YouTube: |
| 81 | + |
| 82 | +[</br>Building Qt5 UIs with the MachinekitSDK](https://www.youtube.com/watch?v=IdB5769JtqI&feature=youtu.be) |
| 83 | + |
| 84 | +[</br>HelloWorld in QtQuickVcp](http://www.youtube.com/watch?v=hyY1DoJ3mOA) |
| 85 | + |
| 86 | +More detailed videos for specific areas will follow. |
| 87 | + |
| 88 | + |
| 89 | + |
| 90 | + |
0 commit comments