Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

changed user name to qtquickvcp #145

Merged
merged 1 commit into from Feb 12, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Expand Up @@ -4,14 +4,14 @@ A remote UI implementation for [Machinekit](https://github.com/machinekit/machin

| | Travis CI | AppVeyor |
|----------|:----:|:----:|
| Build Status | [![Build Status](https://api.travis-ci.org/machinekoder/QtQuickVcp.svg?branch=master)](http://travis-ci.org/machinekoder/QtQuickVcp) | [![Build Status](https://ci.appveyor.com/api/projects/status/h8pi1hm0gj15nmgm?svg=true)](https://ci.appveyor.com/project/machinekoder/qtquickvcp) |
| Build Status | [![Build Status](https://api.travis-ci.org/qtquickvcp/QtQuickVcp.svg?branch=master)](http://travis-ci.org/qtquickvcp/QtQuickVcp) | [![Build Status](https://ci.appveyor.com/api/projects/status/h8pi1hm0gj15nmgm?svg=true)](https://ci.appveyor.com/project/machinekoder/qtquickvcp) |

## Features

* enables building remote user interfaces for Machinekit
* automatic service discovery
* control one or multiple Machinekit instance
* remote UI deployment via [MachinekitClient](https://github.com/machinekoder/MachinekitClient/)
* remote UI deployment via MachinekitClient
* remote Machinekit instance launcher
* UI components for machine control applications
* textual GCode preview
Expand Down Expand Up @@ -226,19 +226,19 @@ while True:
```

##### Modifications for 3D Printers
The Machineface user interface is especially designed for controlling 3D printers. Therefore it features some additional controls for heatbed, extruder temperature and more. It implements following a set of [MCodes](https://github.com/machinekoder/TCT3D/blob/revision2/UNIPRINT-3D.ini#L86) as well as a few [HAL signals](https://github.com/machinekoder/TCT3D/blob/revision2/UNIPRINT-3D.hal#L610). You may also want to take a look at the source code of Machineface: [DisplayPanel.qml](https://github.com/machinekoder/Machineface/blob/master/Machineface/DisplayPanel.qml#L54)
The Machineface user interface is especially designed for controlling 3D printers. Therefore it features some additional controls for heatbed, extruder temperature and more. It implements following a set of [MCodes](https://github.com/machinekoder/TCT3D/blob/revision2/UNIPRINT-3D.ini#L86) as well as a few [HAL signals](https://github.com/machinekoder/TCT3D/blob/revision2/UNIPRINT-3D.hal#L610). You may also want to take a look at the source code of Machineface: [DisplayPanel.qml](https://github.com/qtquickvcp/Machineface/blob/master/Machineface/DisplayPanel.qml#L54)

#### Cloning the User Interfaces
At the moment two user interfaces based on QtQuickVcp exist:

[Machineface](https://github.com/machinekoder/Machineface): a user interfaces designed for the use with small screens especially for 3D printers
[Machineface](https://github.com/qtquickvcp/Machineface): a user interfaces designed for the use with small screens especially for 3D printers

[Cetus](https://github.com/machinekoder/Cetus.git): a full-featured user interfaces that should provide something like Axis
[Cetus](https://github.com/qtquickvcp/Cetus.git): a full-featured user interfaces that should provide something like Axis

Clone both user interfaces on your device with Machinekit installed. I recommend **forking the user interfaces on GitHub** and cloning the fork so you can push modifications upstream quickly. To modify these user interfaces a simple text editor is sufficient. Using a text editor with syntax highlighting for QML might improve the development experience. (e.g. Kate or Qt Creator)

git clone https://github.com/machinekoder/Cetus.git
git clone https://github.com/machinekoder/Machineface.git
git clone https://github.com/qtquickvcp/Cetus.git
git clone https://github.com/qtquickvcp/Machineface.git

#### Install the MachinekitClient
Please download and install the MachinekitClient from the <a href="#download">Download section</a>.
Expand Down Expand Up @@ -567,9 +567,9 @@ See also [C++ Hash Deprecation Warning](http://stackoverflow.com/q/30430789/4599
<a name="building_qtquickvcp" />
### Building QtQuickVcp

After you have all the requirements installed clone and build the [QtQuickVcp repo](https://github.com/machinekoder/QtQuickVcp).
After you have all the requirements installed clone and build the [QtQuickVcp repo](https://github.com/qtquickvcp/QtQuickVcp).

git clone https://github.com/machinekoder/QtQuickVcp
git clone https://github.com/qtquickvcp/QtQuickVcp

Before building the project **modify the paths.pri file if necessary**.

Expand All @@ -594,7 +594,7 @@ QMAKE=~/bin/Qt/5.*/gcc*/bin/qmake
QT_INSTALL_PREFIX=~/bin/Qt/5.*/gcc*

# download and install QtQuickVcp
git clone https://github.com/machinekoder/QtQuickVcp
git clone https://github.com/qtquickvcp/QtQuickVcp
mkdir -p build/QtQuickVcp
cd build/QtQuickVcp

Expand All @@ -610,7 +610,7 @@ make install_docs
<a name="machinekit_sdk" />
### MachinekitSDK
If you also want to have QtQuickVcp specific wizards and extensions
for QtCreator please continue with the install instructions for the [MachinekitSDK](https://github.com/machinekoder/MachinekitSDK)
for QtCreator please continue with the install instructions for the [MachinekitSDK](https://github.com/qtquickvcp/MachinekitSDK)

<a name="contributing"/>
## Contributing
Expand Down
2 changes: 1 addition & 1 deletion build/Linux/android/Recipe
Expand Up @@ -51,7 +51,7 @@ export ANDROID_SDK_ROOT="${PWD}/android-sdk"
export ANDROID_HOME="${PWD}/android-sdk"

# If not building on Travis then might need to fetch QtQuickVcp
[ -d "QtQuickVcp" ] || git clone --depth 1 https://github.com/machinekoder/QtQuickVcp.git
[ -d "QtQuickVcp" ] || git clone --depth 1 https://github.com/qtquickvcp/QtQuickVcp.git

cd QtQuickVcp

Expand Down
2 changes: 1 addition & 1 deletion build/Linux/portable/Recipe
Expand Up @@ -47,7 +47,7 @@ export QT_QPA_PLATFORM_PLUGIN_PATH="${PWD}/qt5/plugins/platforms"
export QT_INSTALL_PREFIX="${PWD}/qt5"

# If not building on Travis then might need to fetch QtQuickVcp
[ -d "QtQuickVcp" ] || git clone --depth 1 https://github.com/machinekoder/QtQuickVcp.git
[ -d "QtQuickVcp" ] || git clone --depth 1 https://github.com/qtquickvcp/QtQuickVcp.git

cd QtQuickVcp

Expand Down
4 changes: 2 additions & 2 deletions build/deployment-scripts/android_armv7.ini
Expand Up @@ -19,8 +19,8 @@ pkgName="%(realname)s"
pkgPattern="%(realname)s"

[GitHub]
user="machinekoder"
repo="machinekoder/MachinekitClient"
user="qtquickvcp"
repo="qtquickvcp/MachinekitClient"

[Release]
name="MachinekitClient %(tag)s"
Expand Down
4 changes: 2 additions & 2 deletions build/deployment-scripts/linux_x64.ini
Expand Up @@ -21,8 +21,8 @@ pkgName="%(realname)s"
pkgPattern="%(realname)s"

[GitHub]
user="machinekoder"
repo="machinekoder/MachinekitClient"
user="qtquickvcp"
repo="qtquickvcp/MachinekitClient"

[Release]
name="MachinekitClient %(tag)s"
Expand Down
6 changes: 3 additions & 3 deletions build/travis/job2_AppImage/bintray_app.sh
Expand Up @@ -45,9 +45,9 @@ BINTRAY_API_KEY="${BINTRAY_API_KEY:?Environment variable missing/empty!}" # env
BINTRAY_REPO_OWNER="${BINTRAY_REPO_OWNER:-$BINTRAY_USER}" # env, or use BINTRAY_USER as default
[ "${BINTRAY_REPO_OWNER}" == "machinekoder" ] && TRUSTED="true" || TRUSTED="false"

WEBSITE_URL="https://github.com/machinekoder/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/machinekoder/QtQuickVcp/issues"
GITHUB_REPO="machinekoder/QtQuickVcp"
WEBSITE_URL="https://github.com/qtquickvcp/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/qtquickvcp/QtQuickVcp/issues"
GITHUB_REPO="qtquickvcp/QtQuickVcp"
VCS_URL="https://github.com/${GITHUB_REPO}.git" # Mandatory for packages in free Bintray repos
LICENSE="LGPL-2.1"

Expand Down
6 changes: 3 additions & 3 deletions build/travis/job2_AppImage/bintray_lib.sh
Expand Up @@ -45,9 +45,9 @@ BINTRAY_API_KEY="${BINTRAY_API_KEY:?Environment variable missing/empty!}" # env
BINTRAY_REPO_OWNER="${BINTRAY_REPO_OWNER:-$BINTRAY_USER}" # env, or use BINTRAY_USER as default
[ "${BINTRAY_REPO_OWNER}" == "machinekoder" ] && TRUSTED="true" || TRUSTED="false"

WEBSITE_URL="https://github.com/machinekoder/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/machinekoder/QtQuickVcp/issues"
GITHUB_REPO="machinekoder/QtQuickVcp"
WEBSITE_URL="https://github.com/qtquickvcp/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/qtquickvcp/QtQuickVcp/issues"
GITHUB_REPO="qtquickvcp/QtQuickVcp"
VCS_URL="https://github.com/${GITHUB_REPO}.git" # Mandatory for packages in free Bintray repos
LICENSE="LGPL-2.1"

Expand Down
6 changes: 3 additions & 3 deletions build/travis/job3_Android/bintray_android.sh
Expand Up @@ -45,9 +45,9 @@ BINTRAY_API_KEY="${BINTRAY_API_KEY:?Environment variable missing/empty!}" # env
BINTRAY_REPO_OWNER="${BINTRAY_REPO_OWNER:-$BINTRAY_USER}" # env, or use BINTRAY_USER as default
[ "${BINTRAY_REPO_OWNER}" == "machinekoder" ] && TRUSTED="true" || TRUSTED="false"

WEBSITE_URL="https://github.com/machinekoder/MachinekitClient"
ISSUE_TRACKER_URL="https://github.com/machinekoder/QtQuickVcp/issues"
GITHUB_REPO="machinekoder/QtQuickVcp"
WEBSITE_URL="https://github.com/qtquickvcp/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/qtquickvcp/QtQuickVcp/issues"
GITHUB_REPO="qtquickvcp/QtQuickVcp"
VCS_URL="https://github.com/${GITHUB_REPO}.git" # Mandatory for packages in free Bintray repos
LICENSE="LGPL-2.1"

Expand Down
6 changes: 3 additions & 3 deletions build/travis/job3_Android/bintray_lib.sh
Expand Up @@ -45,9 +45,9 @@ BINTRAY_API_KEY="${BINTRAY_API_KEY:?Environment variable missing/empty!}" # env
BINTRAY_REPO_OWNER="${BINTRAY_REPO_OWNER:-$BINTRAY_USER}" # env, or use BINTRAY_USER as default
[ "${BINTRAY_REPO_OWNER}" == "machinekoder" ] && TRUSTED="true" || TRUSTED="false"

WEBSITE_URL="https://github.com/machinekoder/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/machinekoder/QtQuickVcp/issues"
GITHUB_REPO="machinekoder/QtQuickVcp"
WEBSITE_URL="https://github.com/qtquickvcp/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/qtquickvcp/QtQuickVcp/issues"
GITHUB_REPO="qtquickvcp/QtQuickVcp"
VCS_URL="https://github.com/${GITHUB_REPO}.git" # Mandatory for packages in free Bintray repos
LICENSE="LGPL-2.1"

Expand Down
6 changes: 3 additions & 3 deletions build/travis/job_macos/bintray_app.sh
Expand Up @@ -37,9 +37,9 @@ BINTRAY_API_KEY="${BINTRAY_API_KEY:?Environment variable missing/empty!}" # env
BINTRAY_REPO_OWNER="${BINTRAY_REPO_OWNER:-$BINTRAY_USER}" # env, or use BINTRAY_USER as default
[ "${BINTRAY_REPO_OWNER}" == "machinekoder" ] && TRUSTED="true" || TRUSTED="false"

WEBSITE_URL="https://github.com/machinekoder/MachinekitClient"
ISSUE_TRACKER_URL="https://github.com/machinekoder/QtQuickVcp/issues"
GITHUB_REPO="machinekoder/QtQuickVcp"
WEBSITE_URL="https://github.com/qtquickvcp/MachinekitClient"
ISSUE_TRACKER_URL="https://github.com/qtquickvcp/QtQuickVcp/issues"
GITHUB_REPO="qtquickvcp/QtQuickVcp"
VCS_URL="https://github.com/${GITHUB_REPO}.git" # Mandatory for packages in free Bintray repos
LICENSE="LGPL-2.1"

Expand Down
6 changes: 3 additions & 3 deletions build/travis/job_macos/bintray_lib.sh
Expand Up @@ -37,9 +37,9 @@ BINTRAY_API_KEY="${BINTRAY_API_KEY:?Environment variable missing/empty!}" # env
BINTRAY_REPO_OWNER="${BINTRAY_REPO_OWNER:-$BINTRAY_USER}" # env, or use BINTRAY_USER as default
[ "${BINTRAY_REPO_OWNER}" == "machinekoder" ] && TRUSTED="true" || TRUSTED="false"

WEBSITE_URL="https://github.com/machinekoder/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/machinekoder/QtQuickVcp/issues"
GITHUB_REPO="machinekoder/QtQuickVcp"
WEBSITE_URL="https://github.com/qtquickvcp/QtQuickVcp"
ISSUE_TRACKER_URL="https://github.com/qtquickvcp/QtQuickVcp/issues"
GITHUB_REPO="qtquickvcp/QtQuickVcp"
VCS_URL="https://github.com/${GITHUB_REPO}.git" # Mandatory for packages in free Bintray repos
LICENSE="LGPL-2.1"

Expand Down