Commit df08be64 authored by Brian Douglass's avatar Brian Douglass
Browse files

Updated docs to have better heading links

parent ba1dd540
......@@ -3,45 +3,47 @@
App Templates
=============
+-------------------------------------------------------+
| Pure QML App (built using CMake) - ``pure-qml-cmake`` |
+-------------------------------------------------------+
Pure QML App (built using CMake)
--------------------------------
An app template that is setup for a purely QML app. It includes a CMake setup
to allow for easy translations.
Check it out on `GitHub <https://github.com/bhdouglass/ut-app-pure-qml-cmake-template>`__.
+---------------------------------------------+
| C++/QML App (built using CMake) - ``cmake`` |
+---------------------------------------------+
C++/QML App (built using CMake)
-------------------------------
An app template that is setup for a QML app with a C++ plugin. It includes a CMake
setup to allow for easy translation.
Check it out on `GitHub <https://github.com/bhdouglass/ut-app-cmake-template>`__.
+-------------------------------------------------------+
| Python/QML App (built using CMake) - ``python-cmake`` |
+-------------------------------------------------------+
Python/QML App (built using CMake)
----------------------------------
An app template that is setup for an app using Python with QML. It includes a
CMake setup to allow for easy translation.
Check it out on `GitHub <https://github.com/bhdouglass/ut-app-python-cmake-template>`__.
+---------------------+
| HTML App - ``html`` |
+---------------------+
HTML App
--------
An app template that is setup for a local HTML app.
Check it out on `GitHub <https://github.com/bhdouglass/ut-app-html-template>`__.
+------------------------+
| Simple Webapp - webapp |
+------------------------+
Simple Webapp
-------------
An app template that is setup as a thin wrapper around an existing website.
Check it out on `GitHub <https://github.com/bhdouglass/ut-app-webapp-template>`__.
Go/QML App
----------
An app template that is setup for a QML app with a Go backend.
Check it out on `GitHub <https://github.com/bhdouglass/ut-app-go-template>`__.
......@@ -3,56 +3,47 @@
Build Templates
===============
+----------------+
| pure-qml-qmake |
+----------------+
pure-qml-qmake
--------------
A purely qml qmake project.
+-------+
| qmake |
+-------+
qmake
-----
A project that builds using qmake (has more than just QML).
+----------------+
| pure-qml-cmake |
+----------------+
pure-qml-cmake
--------------
A purely qml cmake project
+-------+
| cmake |
+-------+
cmake
-----
A project that builds using cmake (has more than just QML)
+--------+
| custom |
+--------+
custom
------
A custom build command will be used.
+---------+
| cordova |
+---------+
cordova
-------
A project that builds using cordova
+------+
| pure |
+------+
pure
----
A project that does not need to be compiled. All files in the project root will be copied into the click.
+--------+
| python |
+--------+
python
------
A project that uses python and does not need to be compiled.
+----+
| go |
+----+
go
--
A project that uses go version 1.6.
......@@ -18,93 +18,79 @@ Example:
}
+---------+
| package |
+---------+
package
-------
The full package name (appname.developer). This is optional and will be read
from manifest.json if left blank.
+-----+
| app |
+-----+
app
---
The app name (appname.developer). This is optional and will be read
from manifest.json if left blank.
+-----+
| sdk |
+-----+
sdk
---
Optional, Defaults to `ubuntu-sdk-15.04`
+------+
| arch |
+------+
arch
----
Optional, the default is armhf. You may also specify this as a cli arg
(ex: ``--arch="armhf"``)
+----------+
| prebuild |
+----------+
prebuild
--------
Optional, a custom command to run before a build.
+----------+
| template |
+----------+
template
--------
Optional, see :ref:`build template <build-templates>` for the full list of options.
If left blank the template will be auto detected.
+---------+
| premake |
+---------+
premake
-------
Optional, a custom command to execute before make is run.
+-------+
| build |
+-------+
build
-----
Optional, a custom command to run instead of the default build. If using
the `custom` template this is required.
+-----------+
| postbuild |
+-----------+
postbuild
---------
Optional, a custom command to execute after build and before click build.
+--------+
| launch |
+--------+
launch
------
Optional, a custom command to launch the app.
+-----+
| ssh |
+-----+
ssh
---
Optional, the IP of the device you wish to install and launch the app on.
+-----+
| dir |
+-----+
dir
---
Optional, a custom build directory. Defaults to ``./build/``
+------+
| kill |
+------+
kill
----
Optional, a custom process name to kill (useful for killing the running app,
then relaunching it). If left blank the process name will be assumed.
+---------+
| scripts |
+---------+
scripts
-------
Optional, an object detailing custom commands to run. For example:
......@@ -117,40 +103,35 @@ Optional, an object detailing custom commands to run. For example:
To run the command on the device use the ``--device`` argument ( ex: ``clickable test --device`` ).
+--------+
| chroot |
+--------+
chroot
------
Optional, whether or not to use a chroot to build the app. Default is to use
docker to build the app. Chroots are deprecated and their support will be removed
in a future version of clickable.
+-----+
| lxd |
+-----+
lxd
---
Optional, whether or not to use a lxd container to build the app. Default is to use
docker to build the app. LXD is deprecated and its support will be removed
in a future version of clickable.
+---------+
| default |
+---------+
default
-------
Optional, a list of space separated sub-commands to run when no sub-commands are
specified. Defaults to ``kill clean build click-build install launch``.
+--------------+
| dependencies |
+--------------+
dependencies
------------
Optional, a list of dependencies that will be installed in the build container.
These will be assumed to be `dependencie:arch` unless `specificDependencies`
is set to `true`.
+--------+
| ignore |
+--------+
ignore
------
Optional, a list of files to ignore when building a `pure` template
Example:
......@@ -163,15 +144,13 @@ Example:
]
``
+-----------+
| make_jobs |
+-----------+
make_jobs
---------
Optional, the number of jobs to use when running make, equivalent to make's `-j`
option. If left blank this defaults to the number of cpus your computer has.
+--------+
| gopath |
+--------+
gopath
------
Optional, the gopath on the host machine. If left blank, the ``GOPATH`` env var will be used.
......@@ -8,14 +8,17 @@ From the root directory of your project you have the following sub-commands avai
You can combine the commands together like ``clickable build click_build install launch``
``clickable``
-------------
Runs the default sub-commands specified in the "default" config
``clickable --desktop``
-----------------------
Compile and run the app onthe desktop.
``clickable init``
------------------
Generate a new app from a list of :ref:`app template options <app-templates>`.
......@@ -24,22 +27,27 @@ Generate a new app from a list of :ref:`app template options <app-templates>`.
Generate a new app from an :ref:`app template <app-templates>` by name.
``clickable shell``
-------------------
Opens a shell on the device via ssh. This is similar to the ``phablet-shell`` command.
``clickable kill``
------------------
Kills a running process (specified by the config). Using this you can relaunch your app.
``clickable clean``
-------------------
Cleans out the build dir.
``clickable build``
-------------------
Builds the project using the specified template, build dir, and build commands.
``clickable click-build``
-------------------------
Takes the built files and compiles them into a click package (you can find it in the build dir).
......@@ -49,6 +57,7 @@ Takes the built files and compiles them into a click package, outputting the
compiled click to the directory specified by ``--output``.
``clickable install``
---------------------
Takes a built click package and installs it on a device.
......@@ -57,6 +66,7 @@ Takes a built click package and installs it on a device.
Installs the specified click package on the device
``clickable launch``
--------------------
Launches the app on a device.
......@@ -65,28 +75,34 @@ Launches the app on a device.
Launches the specified app on a device.
``clickable logs``
------------------
Follow the apps log file on the device.
``clickable setup-docker``
--------------------------
Configure docker for use with clickable.
``clickable display-on``
------------------------
Turns on the device's display and keeps it on until you hit CTRL+C.
``clickable no-lock``
---------------------
Turns off the device's display timeout.
``clickable devices``
---------------------
Lists the serial numbers and model names for attached devices. Useful when
multiple devices are attached and you need to know what to use for the ``-s``
argument.
``clickable <custom command>``
------------------------------
Runs a custom command specified in the "scripts" config
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment