summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2012-12-16 09:25:09 +0100
committerUlf Magnusson <ulfalizer@gmail.com>2012-12-16 09:25:09 +0100
commit334b16962adfd036650156a18edf9847ae5f33d9 (patch)
tree6ae2d4ee08b4e625125061ff4a4059bd030c7306
parent110f6841e036612ab73abc2a293dd54c6e1a73fb (diff)
Spiffy up README.
-rw-r--r--README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/README.md b/README.md
index b668366..ef41deb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-Kconfiglib
-==========
+# Kconfiglib #
A Python library for doing stuff with Kconfig-based configuration systems. Can
extract information, query and set symbol values, and read and write
@@ -7,11 +6,12 @@ extract information, query and set symbol values, and read and write
utilities in the kernel, usually invoked via make targets such as
<i>menuconfig</i> and <i>defconfig</i>.
-See kconfiglib.py for a longer introduction. The (extensive) documentation is
-generated with
+The (extensive) documentation is generated with
> $ pydoc [-w] kconfiglib
+## Installation ##
+
Installation instructions for the Linux kernel (in the kernel root):
> $ git clone git://github.com/ulfalizer/Kconfiglib.git
@@ -21,11 +21,14 @@ Installation instructions for the Linux kernel (in the kernel root):
In addition to creating a handy interface, the make targets are needed to pick
up environment variables set in the kernel makefiles, which are referenced in
-the Kconfig files (ARCH, SRCARCH, and KERNELVERSION as of Linux 3.7.0).
+the Kconfig files (<i>ARCH</i>, <i>SRCARCH</i>, and <i>KERNELVERSION</i> as of
+Linux 3.7.0).
Please tell me if the patch does not apply. It should be trivial to apply
manually.
+## Test suite ##
+
The test suite is run with
> $ python Kconfiglib/testsuite.py
@@ -35,6 +38,8 @@ configurations generated by Kconfiglib with configurations generated by
<i>scripts/kconfig/conf</i> for a number of cases. You might want to use the
"speedy" option; see testsuite.py.
+## Misc. notes ##
+
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
unlikely to be exactly what you want as a user (hence why they're internal :).