From a0ab84355bc17fd85f91dbe2a1a39ddcba92a765 Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Fri, 29 May 2015 16:22:56 +0200 Subject: Add "installation instructions" for non-kernel projects. ...and some other misc. notes. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 388ee46..0c62245 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ modules used outside the kernel, where the name is unlikely to change. ## Installation ## -Installation instructions for the Linux kernel (in the kernel root): +### Installation instructions for the Linux kernel ### + +Run the following commands in the kernel root: $ git clone git://github.com/ulfalizer/Kconfiglib.git $ git am Kconfiglib/makefile.patch @@ -37,6 +39,12 @@ Linux v4.0-rc3). Please tell me if the patch does not apply. It should be trivial to apply manually. +### Installation instructions for other projects ### + +The entire library is contained in [kconfiglib.py](kconfiglib.py). Drop it +somewhere and read the documentation. Make sure Kconfiglib sees environment +variables referenced in the configuration. + ## Documentation ## The (extensive) documentation is generated by running @@ -47,6 +55,11 @@ in the Kconfiglib/ directory. For HTML output, use $ pydoc -w kconfiglib + +You could also browse the docstrings directly in [kconfiglib.py](kconfiglib.py). + +Please tell me if something is unclear to you or can be explained better. The Kconfig +language has some dark corners. ## Examples ## -- cgit v1.2.3