aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKavindra Palaraja <kpalaraja@luxoft.com>2019-04-30 12:32:17 +0200
committerKavindra Palaraja <kpalaraja@luxoft.com>2019-05-07 12:47:38 +0000
commit1bb4166c4e71a1c1de957209e522a475dc3dfa7b (patch)
tree22d8dcc26950faf55853a0d207fcebe921dda239
parent9cbacb280d52d76b9766c211477d82cf5425cc34 (diff)
[docs] Some fixes to simplify the content
Change-Id: Id85a46868a316bb2ed6365651c64911d6c894134 Reviewed-by: Svetlana Abramenkova <sabramenkova@luxoft.com>
-rw-r--r--doc/concepts.qdoc36
-rw-r--r--doc/index.qdoc18
-rw-r--r--doc/usage.qdoc24
3 files changed, 38 insertions, 40 deletions
diff --git a/doc/concepts.qdoc b/doc/concepts.qdoc
index 1013e4c..c23a1eb 100644
--- a/doc/concepts.qdoc
+++ b/doc/concepts.qdoc
@@ -94,7 +94,7 @@ Bench is sufficient; you can see the live preview on your local machine.
\table
\header
- \li QmlLive Feature
+ \li Feature
\li Description
\row
\li QmlLive Bench
@@ -113,11 +113,11 @@ developer's machine.
QmlLive Bench supports the following features:
\list
- \li live reload a \c main file, or a selected component
- \li watch workspace updates
- \li provide a GUI to set a workspace or project settings, configure host connections,
+ \li live reloads a \c main.qml file, or a selected component
+ \li watches the workspace for updates
+ \li provides a GUI to set a workspace or project settings, configure host connections,
import paths, and so on
- \li Publish each file change to all local and remote QmlLive Runtimes on the
+ \li publishes each file change to all local and remote QmlLive Runtimes on the
embedded devices
\li lets the user select different files to watch, for certain QmlLive Runtime
instances, on different connected devices
@@ -130,15 +130,15 @@ QmlLive Bench supports the following features:
QmlLive Runtime supports the following features:
\list
- \li live reload a \c main file, or a selected component
- \li listens workspace updates from the QmlLive Bench
+ \li live reloads a \c main.qml file, or a selected component
+ \li listens for workspace updates from QmlLive Bench
\endlist
\image concept.png
\section1 Local Sessions
-For a local session you only need the QmlLive Bench. It contains all of the
+For a local session you only need QmlLive Bench. It contains all of the
required components in an easy-to-use interface. As you type and save, the
output is displayed on your machine in a fraction of a second. Local sessions
are best suited for a multi-monitor setup where you see your code on one
@@ -166,9 +166,9 @@ You can always connect more devices, or devices with different sizes.
\section1 Create Your Own QmlLive Runtime
Some projects include custom C++ or native code. Those languages require a
-compilation step and cannot be reloaded directly with QmlLive reloading. For
-such case you can develop you own QmlLive Runtime based on the QmlLive library.
-For more details see \l{Custom Runtime}.
+compilation step and cannot be reloaded directly with QmlLive. In this case,
+you can develop your own QmlLive Runtime based on the QmlLive library. For
+more details see \l{Custom Runtime}.
\section1 Structure QML Apps For Live Coding
@@ -193,9 +193,9 @@ and \e fragment.
\endcode
These elements form a hierarchy from large UI elements to the smaller entities
-and internals. The main benefit of this hierarchy, is that it allows us to
-share a common vocabulary with our customers and ensures the design is always
-aligned with this shared definition.
+and internals. The main benefit of this hierarchy, is that it allows the design
+and the development team to share a common vocabulary with their customers, and
+ensures that the product's design is always aligned with this shared definition.
These elements are defined as follows:
@@ -210,10 +210,10 @@ These elements are defined as follows:
UI developer.
\endlist
-Designing a UI requires an understanding of the initial display layout
-and its screen navigation structure, and of the structure of individual screens and
-their panels. It is also required to define a common set of components to be used inside
-the panels. The fragments are implementation-specific.
+Designing a UI requires understanding the initial display layout, its screen
+navigation structure, as well as the structure of individual screens and their
+panels. It's also necessary to define a common set of components for use inside
+the panels; however, the fragments are implementation-specific.
*/
diff --git a/doc/index.qdoc b/doc/index.qdoc
index f0c268a..0d49d15 100644
--- a/doc/index.qdoc
+++ b/doc/index.qdoc
@@ -45,18 +45,16 @@ to change your QML user interface source code and view the result in realtime.
Often in User Interface (UI) development you need to edit the placement or
animations to provide the user experience the design team envisions. This
-process of try-and-error is tedious with the classic \e{edit-save-run-exit}
-cycle. QmlLive makes this cycle more effective: the scene reloads automatically
-when a file changes.
-
-\section1 Contents
+process of trial and error is tedious with the classic \e{edit-save-run-exit}
+cycle. QmlLive makes this cycle more effective: whenever a file changes, the
+scene reloads automatically.
\list
- \li \l{Installation} - How to install QmlLive from the source code
- \li \l{Usage} - How to use the different parts
- \li \l{Concepts} - A general overview of the system
- \li \l{qmllive-examples}{Examples} - Try out QmlLive
- \li The API reference to build your custom render scene:
+ \li \l{Installation}
+ \li \l{Usage}
+ \li \l{Concepts}
+ \li \l{qmllive-examples}{Examples}
+ \li API Reference
\list
\li \l{qmllive}{QmlLive} - The QmlLive library API
\li \l{ipc}{IPC} - The internal IPC API
diff --git a/doc/usage.qdoc b/doc/usage.qdoc
index 655b599..6dc7aaf 100644
--- a/doc/usage.qdoc
+++ b/doc/usage.qdoc
@@ -37,26 +37,26 @@
\section1 Introduction
-The QmlLive system is structured in a modular fashion to be able to meet various requirements.
+QmlLive is structured in a modular way, to be able to meet various usage requirements.
-Normally, in the early phase of a project, you want to use QmlLive Bench, which has everything
+In the early phase of a project, normally, you want to use \b QmlLive Bench, which has everything
included in a typical desktop application.
-Later in the project, you may want to test your UI code on a target device. For this, you can use
-the QmlLive Bench in combination with the QmlLive Runtime. This combination offers you a default
-QML renderer to run on the device and a small remote application on the desktop to control it.
+Later in the project, you may want to test your UI code on a device. For this, you can combine
+QmlLive Bench with \b QmlLive Runtime. This combination provides you a default QML renderer to
+run on the device and a small remote application on the desktop to control it.
-For C++ developers, you can integrate the QmlLive system into your own custom runtime using the
-\l LiveNodeEngine class with a few lines of code, and then use the QmlLive Bench to control it.
+For C++ developers, it's possible to integrate QmlLive into your own custom runtime using the
+\l LiveNodeEngine class with a few lines of code, and then using QmlLive Bench to control it.
-\section1 The Workbench
+\section1 QmlLive Bench
-The standard workbench is the all inclusive QML live reloading tool, that allows you to select a
-workspace to watch over and provides a default QML runtime for the selected QML document.
+QmlLive Bench is the all inclusive QML live reloading tool, that allows you to select a workspace
+to watch over and provides a default QML runtime for the selected QML document.
-\image workbench.png The Workbench
+\image workbench.png QmlLive Bench
-To launch the Workbench, run the following command:
+To launch the Bench, run the following command:
\code
$(QMLIVEPROJECT)/bin/qmllivebench[.exe]