1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
|
# Kworkflow
# About
This set of scripts have a simple mission: reduces the environment and setup
overhead for developing for GNU/Linux. Kw is composed of different scripts
unified in a single interface after the installation, kw commands become
available in the command line interface.
Kworkflow stands for Kernel Workflow.
# 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 --html
```
Finally, you can use your browser to look 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/rodrigosiqueira/kworkflow/labels/good%20first%20issue)
and don't forget to read our
[Contribuitor's Guide](https://siqueira.tech/doc/kw/content/howtocontribute.html)
(or [howtocontribute file](documentation/content/howtocontribute.rst)).
# License
Kworkflow is under GPL-2.0+
|