|
2821.2.1
by Zygmunt Krynicki
add top-level README.md |
1 |
The Checkbox Project
|
2 |
====================
|
|
3 |
||
4 |
This document serves as a roadmap to the curious folk that want to know how to |
|
5 |
make in-and-outs of the various files living here. |
|
6 |
||
7 |
The checkbox project is actually a collection of smaller projects, all living |
|
8 |
in one big repository (for several technical and historical reasons). The |
|
9 |
top-level directory as at least the following components (in alphabetical |
|
10 |
order). |
|
11 |
||
|
3189.1.1
by Zygmunt Krynicki
README.md: add a description of checkbox-touch |
12 |
|
|
3516.1.1
by Zygmunt Krynicki
cep: add README files |
13 |
cep
|
14 |
---
|
|
15 |
||
16 |
All of Checkbox Enhancement Proposal documents. All bigger changes to the stack |
|
17 |
have an associated document that explains the change, its implementation and |
|
18 |
impact. |
|
19 |
||
|
3189.1.1
by Zygmunt Krynicki
README.md: add a description of checkbox-touch |
20 |
checkbox-touch
|
21 |
--------------
|
|
22 |
||
23 |
An Ubuntu SDK application (Python + QML) with a modern touch interface, |
|
24 |
optimized for phablet devices. This application is currently under development, |
|
25 |
eventually it will entirely replace checkbox-gui. |
|
26 |
||
|
2821.2.1
by Zygmunt Krynicki
add top-level README.md |
27 |
checkbox-gui
|
28 |
------------
|
|
29 |
||
30 |
An Ubuntu SDK application (C++/QML) with a modern touch interface for testing. |
|
31 |
No actual test definitions exist there. |
|
32 |
||
33 |
This project depends on the checkbox-ng project (for the DBus API) and on a |
|
34 |
number of test providers (that all live or shall live in the providers/ |
|
35 |
top-level directory) |
|
36 |
||
37 |
checkbox-ng
|
|
38 |
-----------
|
|
39 |
||
40 |
A python3 console application that contains a number of executables (most |
|
41 |
notably checkbox and a collection of derivative canonical-\* executables) that |
|
42 |
run a part of checkbox-ng. |
|
43 |
||
44 |
This project depends on plainbox (for all of the core logic) and on a number of |
|
45 |
test providers, similarly to checkbox-gui. |
|
46 |
||
47 |
checkbox-support
|
|
48 |
----------------
|
|
49 |
||
50 |
A python3 library that contains support code for various providers inherited |
|
51 |
from checkbox-old (now removed). This is a dependency of many (but not all) |
|
52 |
providers that are in providers/ |
|
53 |
||
54 |
plainbox
|
|
55 |
--------
|
|
56 |
||
57 |
A python3 library that contains the core logic of testing applications such as |
|
58 |
checkbox. Also a collection of development tools for test authors. |
|
59 |
||
60 |
providers
|
|
61 |
---------
|
|
62 |
||
63 |
A directory with various provider definitions. Have a look at a particular |
|
64 |
provider for details. This is where actual valuable tests are. There are many |
|
65 |
providers as they have different goals and/or dependencies. Some providers |
|
66 |
depend on a base provider for shared job definitions. |
|
67 |
||
68 |
support
|
|
69 |
-------
|
|
70 |
||
71 |
Support code for the project that is never released, for testing, development, |
|
72 |
CI loops, etc. |