From 0af8326576b1ed31e8a7ed753962a77492ac7bde Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Thu, 19 Sep 2024 16:23:34 +0900 Subject: [PATCH] README: Update README file Signed-off-by: Arisu Tachibana --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 266dafc..e239f88 100644 --- a/README.md +++ b/README.md @@ -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)