Introduction
Overview
- What is it? Background?
- What API is used? What version?
- What it test? What it doesn't test?
- Test types?
- Current status? Release? Under developement?
Getting the Latest Version
- Link to gitorious
- Step-by-step guide how to obtain the sources for ...
- Latest release version (official)
- Latest development version
- Link to meego repo to rpm package
Support & Contacts
- Where to get help? IRC, e-mail ...
- Maintainer name + e-mail + substitute name + e-mail
- If there are any specific instructions for reporting bugs for this specific test module, list them here (logs etc)
- Where to report bugs (what component etc)
Documentation
* Links to more documentation?
Licensing
- Please see the file called COPYING
Supported Devices and SW
- List of supported (+ not supported devices, if needed for clarity)
- Versions
- Info about what is known to work
Supported
- N900
- nCDK Medfield (starting from version x.z)
Not supported
- Info about supported MeeGo releases (?)
Test Cases
- List of / link to list of test cases (test case title + description etc)
- If the list is long put them on a separate page
Coverage
- Coverage target
- Textual coverage description
- Link to coverage sheet
- Coverage table (e.g. test types)
- Limitations, what is not covered
Running the Tests
Hardware setup and test environment
- What SW is needed? What packages need to be installed? What versions?
- What HW is needed? What versions?
- How to get accurate measurement results?
- Step-by-step guide for checking that prerequisites are met
- HW version
- Installed packages
- Etc.
Building packages
- How to build package from source code
- using build script
- Manually (if needed)
- How to install package from repo? rpm -i ...
Running test cases
- Step-by-step instructions how to execute tests with an example
- Root or user privileges?
- What to do if something goes wrong?
- How to run in debug mode?
- What to look in log files?
Test result analysis
- Where are the results?
- Log files?
Troubleshooting
- What to do if something fails?
- What to check first?
Configuration file examples
- Configuration file explained
- Example of configuration file
Module Design and Architecture
Architecture
- What APIs are used? What API versions? E.g. Qt Mobility Messaging 1.0.1, link to API doc
- Architecture Diagrams
- Etc.
Known issues
- Link to open bugs on meego bugzilla
- Other known issues listed
Future improvements
- List of planned future improvements
- Later, link to backlog items to be done
References
- Links to API documentation
- Links to referred docs
- Etc.