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

Brian Douglass's avatar
Brian Douglass committed
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.

Brian Douglass's avatar
Brian Douglass committed
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
Brian Douglass's avatar
Brian Douglass committed
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
    usage
23
    config
24
    debugging
Brian Douglass's avatar
Brian Douglass committed
25
    commands
26
    project-config
Brian Douglass's avatar
Brian Douglass committed
27
    env-vars
28
    app-templates
29
    builders
Brian Douglass's avatar
Brian Douglass committed
30
    continuous-integration
Brian Douglass's avatar
Brian Douglass committed
31
    changelog
32
    migration
Brian Douglass's avatar
Brian Douglass committed
33

Brian Douglass's avatar
Cleanup    
Brian Douglass committed
34
35
36
Install Via Pip (Recommended)
-----------------------------

37
38
39
* Install docker, adb, git, python3 and pip3
  (in Ubuntu: ``sudo apt install docker.io adb git python3 python3-pip``)
* Run: ``pip3 install --user --upgrade clickable-ut``
40
* Add pip scripts to your PATH: ``echo 'export PATH="$PATH:~/.local/bin"' >> ~/.bashrc`` and open a new terminal for the setting to take effect
41
* Alternatively, to install nightly builds: ``pip3 install --user git+https://gitlab.com/clickable/clickable.git@dev``
Brian Douglass's avatar
Cleanup    
Brian Douglass committed
42

Brian Douglass's avatar
Brian Douglass committed
43
44
45
Install Via PPA (Ubuntu)
------------------------

46
* 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
47
48
49
* Update your package list: ``sudo apt-get update``
* Install clickable: ``sudo apt-get install clickable``

50
51
52
53

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

Brian Douglass's avatar
Brian Douglass committed
54
55
* Using your favorite AUR helper, install the `clickable-git package <https://aur.archlinux.org/packages/clickable-git/>`__
* Example: ``pacaur -S clickable-git``
56

57
58
59
Getting Started
---------------

Brian Douglass's avatar
Brian Douglass committed
60
:ref:`Read the getting started guide to get started developing with clickable. <getting-started>`
61

62
63
64
Code Editor Integrations
------------------------

Daniel Frost's avatar
Daniel Frost committed
65
66
Use clickable with the `Atom Editor <https://atom.io>`__ by installing `atom-clickable-plugin <https://atom.io/packages/atom-clickable-plugin>`__.
This is an fork of the original (now unmaintained) `atom-build-clickable <https://atom.io/packages/atom-build-clickable>`__
67
68
made by Stefano.

Brian Douglass's avatar
Brian Douglass committed
69
70
71
72
Issues and Feature Requests
---------------------------

If you run into any problems using clickable or have any feature requests you
Brian Douglass's avatar
Brian Douglass committed
73
can find clickable on `GitLab <https://gitlab.com/clickable/clickable/issues>`__.