<img src="images/kw_logo.png" width="600" alt="kworkflow">

About

kw has a simple mission: reduce the setup overhead of working with the Linux kernel and provide tools to support developers in their daily tasks. If you have a set of repeatable tasks that you usually perform while working in your favorite kernel subsystem or similar, consider adding it as a part of kw.

Install

Take a look at Install and Uninstall.

How to

If you want to know more about kw's usage and its commands, take a look at Kw man or, with kw installed, run kw man.

Tests

If you want to know more about kw's tests take a look at kw tests.

Generate Sphinx Documentation

If you want to generate the Sphinx documentation, you can use:

./setup.sh --docs

Finally, you can use your browser to look at the index.html page. For example:

firefox build/index.html

Contributing

We are happy that you want to help us! If you are looking for a good starting point, check those issues and don't forget to read our Contribuitor's Guide (or howtocontribute file).

Reach Out

The best way to get help or make suggestions is by creating issues or making a pull request, someone is likely to reply to these in little time.

License

Kworkflow is under GPL-2.0+