From 31d56fa8a08b912b56d78f71ebfb5704db1c3c44 Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Sun, 16 Dec 2012 07:32:21 +0100 Subject: Spiffy up README.md a bit. --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 43e54be..dbc6996 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ Kconfiglib ========== A Python library for doing stuff with Kconfig-based configuration systems. Can -extract information, query and set symbol values, and read and write .config -files. Highly compatible with the C implementation (the scripts/kconfig/\*conf -utilities in the kernel, usually invoked via make targets such as 'menuconfig' -and 'defconfig'). +extract information, query and set symbol values, and read and write +.config files. Highly compatible with the scripts/kconfig/\*conf +utilities in the kernel, usually invoked via make targets such as +menuconfig and defconfig. See kconfiglib.py for a longer introduction. The (extensive) documentation is generated with @@ -17,7 +17,7 @@ Installation instructions for the Linux kernel (in the kernel root): > $ git clone git://github.com/ulfalizer/Kconfiglib.git > $ git am Kconfiglib/makefile.patch -(Note: The directory name Kconfiglib/ is significant.) +(Note: The directory name Kconfiglib/ is significant.) Please tell me if the patch does not apply. It should be trivial to apply manually. @@ -26,7 +26,10 @@ The test suite is run with > $ python Kconfiglib/testsuite.py -You might want to use the "speedy" option. See testsuite.py. +It includes a set of selftests as well as a set of automatic compatibility +tests that compare the configurations generated by Kconfiglib with those +generated by scripts/kconfig/conf for a number of cases. You might want +to use the "speedy" option; see testsuite.py. Please tell me if you miss some API instead of digging into internals. The internal data structures and APIs, and dependency stuff in particular, are -- cgit v1.2.3