Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
machinekoder committed May 15, 2017
1 parent 0fb5137 commit 4805dc9
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Expand Up @@ -6,3 +6,22 @@ Full-featured remote user interface for Machinekit based on [QtQuickVcp](https:/
![Alt text](/doc/Cetus.png "Cetus")

For more information on how to use Cetus please read the [QtQuickVcp documentation](https://github.com/qtquickvcp/QtQuickVcp).

## Using Cetus

To use Machineface you have to clone the repository on your Machinekit computer:

``` bash
cd ~/
git clone https://github.com/qtquickvcp/Cetus.git
```

Next, you have to supply the path to the directory to the *configserver*.

``` bash
configserver -n 'My Machine' ~/Cetus
```

The UI is then automatically deployed to the [Machinekit Client](https://github.com/qtquickvcp/QtQuickVcp#download)

For more information about using Machinekit with remote user interfaces please read the [QtQuickVcp documentation](https://github.com/machinekoder/QtQuickVcp#using_mkwrapper).

0 comments on commit 4805dc9

Please sign in to comment.