← Back to branch summary

~canonical-platform-qa/autopilot/pdf-build

« back to all changes in this revision

Viewing changes to README

  • Committer: Tarmac
  • Author(s): Thomi Richards
  • Date: 2015-01-20 18:37:47 UTC
  • mfrom: (521.1.4 trunk-add-build-docs)
  • Revision ID: tarmac-20150120183747-yqggfm531yblk4y8
Add build instructions to README.

Approved by PS Jenkins bot, Leo Arias, Christopher Lee.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
5
5
 
6
6
Autopilot is free software, licensed under GNU General Public License (GPLv3+).
7
7
 
 
8
Links
 
9
=====
 
10
 
8
11
- Project Home (Source Code, Version Control, Bug Tracking, etc):
9
12
  https://launchpad.net/autopilot
10
13
 
11
14
- Documentation (Tutorial, FAQ, API Reference, etc):
12
 
  http://unity.ubuntu.com/autopilot/
 
15
  https://developer.ubuntu.com/api/devel/ubuntu-14.10/python/autopilot/
13
16
 
14
17
- IRC channel is #ubuntu-autopilot on irc.freenode.net
15
18
 
16
 
happy hacking!
 
19
 
 
20
Build Instructions
 
21
==================
 
22
 
 
23
Autopilot is not buildable within a python virtualenv, as it requires several packages that are not available on ``pypi``. Instead, either use autopilot from the source tree, or build debian packages instead. Instructions for building debian packages are below:
 
24
 
 
25
Assuming a current ubuntu installation, make sure you have the build tools that are required installed::
 
26
 
 
27
        $ sudo apt-get install devscripts equivs bzr-builddeb
 
28
 
 
29
Then install the build-dependencies for the autopilot packages::
 
30
 
 
31
        $ sudo mk-build-deps -i
 
32
 
 
33
Then build the debian packages::
 
34
 
 
35
        $ bzr bd
 
36
 
 
37
bzr-builddeb will build binary packages into the parent directory, or into '../build-area/' if you do not own the correct gpg key to sign the package. The resulting ``.deb`` files can be installed as normal with ``sudo dpkg -i package.deb``.
 
38
 
 
39
The documentation can be built separately from the debian packages::
 
40
 
 
41
        $ python3 setup.py build_sphinx
 
42
 
 
43
The docs are built into 'build/sphinx/html' and can be opened in the default browser with::
 
44
 
 
45
        $ xdg-open build/sphinx/html/index.html
17
46
 
18
47
Release Manual Tests
19
48
====================
21
50
Not all our tests are automated at the moment. Specifically, the vis tool is lacking some automated tests due to deficiancies in other packages. Until we remedy this situation, the following things need to be manually tested upon an autopilot release:
22
51
 
23
52
- Run the following tests by running both: ``autopilot vis`` and ``autopilot3 vis``.
24
 
 - Run 'window-mocker -testability' and the vis tool. 
 
53
 - Run 'window-mocker -testability' and the vis tool.
25
54
  - Make sure you can select window-mocker from the connection list.
26
55
  - Make sure the top-level tree node is 'window-mocker'
27
56
 - Run the vis tool with the '-testability' flag enabled. Run a second vis tool, and make sure that the second vis tool can introspect the first.