https://github.com/kworkflow/kworkflow
kw is our inglorious kernel developer workflow tool with a simple mission: reduce the overhead with infrastructure setup for Linux development
https://github.com/kworkflow/kworkflow
Last synced: about 1 year ago
JSON representation
kw is our inglorious kernel developer workflow tool with a simple mission: reduce the overhead with infrastructure setup for Linux development
- Host: GitHub
- URL: https://github.com/kworkflow/kworkflow
- Owner: kworkflow
- License: gpl-2.0
- Created: 2018-05-15T21:52:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T22:13:59.000Z (about 1 year ago)
- Last Synced: 2025-04-05T23:18:39.902Z (about 1 year ago)
- Language: Shell
- Homepage: https://kworkflow.org/
- Size: 4.3 MB
- Stars: 158
- Watchers: 10
- Forks: 98
- Open Issues: 151
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesomeos - kworkflow - reduce the overhead with infrastructure setup for Linux development (Linux specific / Tools)
- awesome-os - kworkflow - reduce the overhead with infrastructure setup for Linux development (Linux specific / Tools)
README
[](https://codecov.io/gh/kworkflow/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](documentation/content/installanduninstall.rst).
# How to
If you want to know more about kw's usage and its commands, take a look at
[Kw man](documentation/man/kw.rst) or, with kw installed, run `kw man`.
# Tests
If you want to know more about kw's tests take a look at
[kw tests](documentation/content/tests.rst).
# 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](https://github.com/kworkflow/kworkflow/labels/good%20first%20issue)
and don't forget to read our
[Contribuitor's Guide](https://kworkflow.org/content/howtocontribute.html)
(or [howtocontribute file](documentation/content/howtocontribute.rst)).
# Reach Out
The best way to get help or make suggestions is by creating
[issues](https://github.com/kworkflow/kworkflow/issues) or making a
[pull request](https://github.com/kworkflow/kworkflow/pulls), someone is
likely to reply to these in little time.
You can also reach out to us at the `#kw-devel` channel on the
[OFTC](https://www.oftc.net/) IRC server (**irc.oftc.net**), or
by joining or opening a new discussion on the
[discussions](https://github.com/kworkflow/kworkflow/discussions) page.
# License
Kworkflow is under GPL-2.0+