index.rst 2.07 KB
Newer Older
Brian Douglass's avatar
Brian Douglass committed
1 2 3
Clickable
=========

4 5 6 7
Build and compile Ubuntu Touch apps easily from the command line. Deploy your
apps to your Ubuntu Touch device for testing or test them on any desktop Linux
distribution. Get logs for debugging and directly access a terminal on your device.

8
Clickable is fully Open Source and can be found on `GitLab <https://gitlab.com/clickable/clickable>`__.
9
Clickable is developed by `Brian Douglass <http://bhdouglass.com>`__ and
10
`Jonatan Hatakeyama Zeidler <https://gitlab.com/jonnius>`__ with a huge
11
thank you to all the `contributors <https://gitlab.com/clickable/clickable/graphs/master>`__.
Brian Douglass's avatar
Brian Douglass committed
12 13 14 15 16 17

Using Clickable
---------------

.. toctree::
    :maxdepth: 1
18
    :name: clickable
Brian Douglass's avatar
Brian Douglass committed
19 20

    install
21
    getting-started
Brian Douglass's avatar
Brian Douglass committed
22 23 24
    usage
    commands
    clickable-json
Brian Douglass's avatar
Brian Douglass committed
25
    env-vars
26
    app-templates
Brian Douglass's avatar
Brian Douglass committed
27
    build-templates
Brian Douglass's avatar
Brian Douglass committed
28
    continuous-integration
Brian Douglass's avatar
Brian Douglass committed
29
    changelog
Brian Douglass's avatar
Brian Douglass committed
30

Brian Douglass's avatar
Brian Douglass committed
31 32 33 34
Install Via Pip (Recommended)
-----------------------------

* Install docker, adb, and pip3
35
* Run (may need sudo): ``pip3 install git+https://gitlab.com/clickable/clickable.git``
Brian Douglass's avatar
Brian Douglass committed
36

Brian Douglass's avatar
Brian Douglass committed
37 38 39
Install Via PPA (Ubuntu)
------------------------

40
* Add the `PPA <https://launchpad.net/~bhdouglass/+archive/ubuntu/clickable>`__ to your system: ``sudo add-apt-repository ppa:bhdouglass/clickable``
Brian Douglass's avatar
Brian Douglass committed
41 42 43
* Update your package list: ``sudo apt-get update``
* Install clickable: ``sudo apt-get install clickable``

44 45 46 47 48 49 50

Install Via AUR (Arch Linux)
----------------------------

* Using your favorite AUR helper, install the `clickable package <https://aur.archlinux.org/packages/clickable/>`__
* Example: ``pacaur -S clickable``

51 52 53
Getting Started
---------------

54
:ref:`Read the getting started guide to get started developing with clickable. <getting-started>`
55

56 57 58 59 60 61 62
Code Editor Integrations
------------------------

Use clickable with the `Atom Editor <https://atom.io>`__ by installing
`atom-build-clickable <https://atom.io/packages/atom-build-clickable>`__
made by Stefano.

Brian Douglass's avatar
Brian Douglass committed
63 64 65 66
Issues and Feature Requests
---------------------------

If you run into any problems using clickable or have any feature requests you
67
can find clickable on `GitLab <https://gitlab.com/clickable/clickable/issues>`__.