-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from aliceinwire/readme
README: Update README file
- Loading branch information
Showing
1 changed file
with
19 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,33 @@ | ||
# kci-dev | ||
|
||
Stand alone tool for Linux Kernel developers and maintainers that can test local Linux Kernel commits or patch (*.mbox, *.patch) on a enabled KernelCI server | ||
> *cmdline tool for interact with KernelCI* | ||
kci-dev is a cmdline tool for interact with a enabled KernelCI server | ||
|
||
## Quickstart | ||
|
||
Using poetry and virtualenv | ||
```sh | ||
virtualenv .venv | ||
source .venv/bin/activate | ||
pip install poetry | ||
poetry install | ||
poetry run kci-dev | ||
``` | ||
|
||
or | ||
## Contributing to kci-dev | ||
|
||
The kci-dev project welcomes, and depends on, contribution from developers and users in the open source community. | ||
|
||
## Contributing guide | ||
|
||
Run the following checks before sending a PR | ||
```sh | ||
python kci-dev/kci-dev.py | ||
poetry run black --check --verbose . | ||
poetry run isort . --check --diff | ||
poetry run pytest -rP | ||
``` | ||
|
||
## License | ||
|
||
[LGPL-2.1](https://github.com/kernelci/kci-dev/blob/main/LICENSE) |