From 50ea141eadbe43df9e4e7b3a4fbcd666cc33944a Mon Sep 17 00:00:00 2001 From: Gustavo Padovan Date: Tue, 10 Dec 2024 19:57:53 -0300 Subject: [PATCH] docs: Clarify install and usage for a wider audience kci-dev is growing to meet the demand of the kernel community, so our documenation has to follow that movement. This commit is nothing more than just a first stab to document better. Signed-off-by: Gustavo Padovan --- README.md | 2 +- docs/_index.md | 30 +++++++++++++++++++++++++----- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 10a8cda..41f3ff4 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ > *cmdline tool for interact with KernelCI* -kci-dev is a cmdline tool for interact with a enabled KernelCI server +Stand alone tool for Linux Kernel developers and maintainers to interact with KernelCI services. ## Quickstart diff --git a/docs/_index.md b/docs/_index.md index 4ddaa79..2debbb7 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -4,25 +4,45 @@ date = 2024-01-14T07:07:07+01:00 description = 'Tool for interact programmatically with KernelCI instances.' +++ -kci-dev is a cmdline tool for interact with a enabled KernelCI server. -Purpose of this tool to provide a easy way to use features of KernelCI Pipeline instance. +Stand alone tool for Linux Kernel developers and maintainers to interact with KernelCI. + +Purpose of this tool to provide an easy-to-use command line tool for developers and maintainers request test from KernelCI, view results, download logs, integrate with scripts, etc. ## Installation -### Using PyPI and virtualenv +You may want to use python virtual environment. +If you are not familiar with it, check [this](https://docs.python.org/3/library/venv.html). + +To quickly setup it: + ```sh virtualenv .venv source .venv/bin/activate +``` + +### Using package from PyPI + +Simply install it using `pip`: + +```sh pip install kci-dev ``` -### Using poetry and virtualenv +### Development snapshot through poetry + +Clone the `kci-dev` repo you want, select the desired branch and run: + ```sh virtualenv .venv source .venv/bin/activate pip install poetry poetry install -poetry run kci-dev +``` + +Then, to execute kci-dev: + +```sh +poetry run kci-dev ``` ## Configuration