Skip to content

Commit

Permalink
README: Add some actual content
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Pitt committed Jul 20, 2012
1 parent 6855b18 commit c2c886a
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 6 deletions.
39 changes: 38 additions & 1 deletion README
Original file line number Diff line number Diff line change
@@ -1,4 +1,41 @@
umockdev
========

Mock hardware devices for creating unit tests
umockdev mocks hardware devices for creating unit tests for libraries and
programs that handle Linux hardware devices.

The UMockdevTestbed class builds a temporary sandbox for mock devices. Right
now this covers sysfs, but other aspects (uevents, /dev, ioctl, etc.) will be
added in the future. You can add a number of devices including arbitrary sysfs
attributes and udev properties, and then run your software in that test bed
that is independent of the actual hardware it is running on. With this you can
simulate particular hardware in virtual environments up to some degree, without
needing any particular privileges or disturbing the whole system.

The library supports gobject-introspection, so that you can also use it with
Python, JavaScript, and other languages which support GI.

Development
===========
Home page: https://github.com/martinpitt/umockdev
GIT: git://github.com/martinpitt/umockdev.git
Bugs: https://github.com/martinpitt/umockdev/issues

Authors
=======
Martin Pitt <martin.pitt@ubuntu.com>

License
=======
umockdev is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

umockdev is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program; If not, see <http://www.gnu.org/licenses/>.
10 changes: 5 additions & 5 deletions src/umockdev.c
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ struct _UMockdevTestbedClass

/**
* SECTION:umockdevtestbed
* @short_description: Build a test bed for testing libudev based/hardware
* handling programs
* @short_description: Build a test bed for testing software that handles Linux
* hardware devices.
*
* The #UMockdevTestbed class is used to build a temporary sandbox for mock
* devices; for now, sysfs is covered, but other aspects (/dev, ioctl, etc.)
* will be added in the future). You can add a number of devices including
* The #UMockdevTestbed class builds a temporary sandbox for mock devices.
* Right now this covers sysfs, but other aspects (uevents, /dev, ioctl, etc.)
* will be added in the future. You can add a number of devices including
* arbitrary sysfs attributes and udev properties, and then run your software
* in that test bed that is independent of the actual hardware it is running
* on. With this you can simulate particular hardware in virtual environments
Expand Down

0 comments on commit c2c886a

Please sign in to comment.