============================================
    Linux-ready firmware developer kit:
               README
============================================

SECTIONS:
1. LFDK (Linux-ready Firmware Developer Kit) Overview
2. Design Goals
3. Implementation
4. Developer Docs & Resources
5. How to Contribute
6. Who are you?


1. LFDK Overview
-------------------

The Linux-ready Firmware Developer Kit is a tool to test how well Linux 
works together with the firmware (BIOS or EFI) of your machine. The main 
component of the kit is a bootable CD, which you can download from our
official site: http://www.linuxfirmwarekit.org .

When this CD boots, the Linux kernel starts and launches the test 
application.  Note: we now support multiple kernel flavors, and you can
choose which ones to test during boot-up. 

This application performs a set of automated tests on your machine 
and then reports the results for interactive inspection and saving. 
The test application also assists you in running some of our non-automated
firmware tests. The idea is that you, as a firmware developer, 
validation team, or kernel developer, use this CD to run the tests against 
your firmware and Linux kernel. 

All code is distributed under the GNU Lesser General Public License v2.1. 
A copy of this license is contained in the COPYING file.

This document gives a brief overview of the developer kit, including its
design goals, implementation, and how to contribute.  Within these
sections, we describe where to find more detailed information.

2. Design Goals
----------------
This project was created with the following design goals:

* Ease of testing Linux without a high learning curve

  We wanted those with little or no Linux experience to easily gets results 
  within 15 minutes, quickly and painlessly. 

* Low-noise, valuable feedback

  Valuable, thorough and decipherable test results with hardly any need
  for the user to manually do anything.

* Simple to contribute

  For it to be simple for other developers to contribute and write their 
  own tests for the kit.

3. Implementation
------------------

Soon, so soon...

4. Developer Docs & Resources
------------------------------

AUTHORS			- who we are
BUILD			- general on how to build and run the tests
COPYING			- license GNU Lesser General Public License v2.1
README			- you're there

All other documentation is available in Documentation/ .

Build.env		- example build environment, list of packages and 
			  kernel version 
HOWTO_CreateISO		- create the bootable kit ISO.
HOWTO_RunStandalone	- build and run standalone tests on your current Linux
			  distro.
QUICKSTART.txt		- a very quick guide to boot the CD and run the tests.
USERGUIDE.txt		- LFDK complete user guide on how to run the kit,
			  navigate through the test results, run interactive
			  tests and hardware pokes.

5. How to Contribute
---------------------

* Patches welcome! Our general mailing list for patches, discussions,
  announcements, etc. is right here:
  http://www.bughost.org/mailman/listinfo/firmwarekit-discuss

* Share your test results at our test-results mailing list:
  http://www.bughost.org/mailman/listinfo/firmwarekit-results

* Found a bug?
  http://www.bughost.org/firmwarekit/enter_bug.cgi

* See HOWTO_CreateTest in our Documentation section.

6. Who are you?
---------------

Check out AUTHORS file :)

