Skip to content

Commit

Permalink
Merge pull request #12 from aliceinwire/readme
Browse files Browse the repository at this point in the history
README: Update README file
  • Loading branch information
aliceinwire authored Sep 19, 2024
2 parents fbf72dc + 0af8326 commit 671ea0c
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
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)

0 comments on commit 671ea0c

Please sign in to comment.