From f18ffa829ca26bcc4ff146c2078d23a7fa14e8cb Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Sat, 8 Jun 2024 17:43:17 +0300 Subject: [PATCH] Improve README --- .github/images/usage.svg | 93 ++++++++++++++++++++++++++++++++++++++++ README.md | 49 +-------------------- 2 files changed, 94 insertions(+), 48 deletions(-) create mode 100644 .github/images/usage.svg diff --git a/.github/images/usage.svg b/.github/images/usage.svg new file mode 100644 index 00000000..e7726dbd --- /dev/null +++ b/.github/images/usage.svg @@ -0,0 +1,93 @@ + + + + bibop Usage + + + + + + + + + + + + + + + + + + Terminal + Usage: bibop {options} recipe + Options + --dry-run, -D .............. Parse and validate recipe + --extra, -X lines .......... Number of output lines for failed action (default: 10) + --pause, -P duration ....... Pause between commands in seconds + --list-packages, -L ........ List required packages + --list-packages-flat, -L1 .. List required packages in one line (useful for scripts) + --variables, -V ............ List recipe variables + --barcode, -B .............. Show unique barcode for test (based on recipe and required packages) + --time, -T ................. Print execution time for every action + --format, -f format ........ Output format (tap13|tap14|json|xml) + --dir, -d dir .............. Path to working directory + --path, -p path ............ Path to directory with binaries + --error-dir, -e dir ........ Path to directory for errors data + --tag, -t tag .............. One or more command tags to run + --quiet, -q ................ Quiet mode + --ignore-packages, -ip ..... Do not check system for installed packages + --no-cleanup, -nl .......... Disable deleting files created during tests + --no-color, -nc ............ Disable colors in output + --help, -h ................. Show this help message + --version, -v .............. Show version + Examples + bibop app.recipe + Run tests from app.recipe + bibop app.recipe --quiet --error-dir bibop-errors + Run tests from app.recipe in quiet mode and save errors data to bibop-errors directory + bibop app.recipe --tag init,service + Run tests from app.recipe and execute commands with tags init and service + bibop app.recipe --extra + Run tests from app.recipe and print the last 10 lines from command output if action was failed + bibop app.recipe --extra=50 + Run tests from app.recipe and print the last 50 lines from command output if action was failed + bibop app.recipe --format json 1> ~/results/app.json + Run tests from app.recipe and save result in JSON format + sudo dnf install $(bibop app.recipe -L1) + Install all packages required for tests + + + diff --git a/README.md b/README.md index b9a728f6..959088aa 100644 --- a/README.md +++ b/README.md @@ -93,54 +93,7 @@ bibop --generate-man | sudo gzip > /usr/share/man/man1/bibop.1.gz ### Usage -``` -Usage: bibop {options} recipe - -Options - - --dry-run, -D Parse and validate recipe - --extra, -X lines Number of output lines for failed action (default: 10) - --pause, -P duration Pause between commands in seconds - --list-packages, -L List required packages - --list-packages-flat, -L1 List required packages in one line (useful for scripts) - --variables, -V List recipe variables - --barcode, -B Show unique barcode for test (based on recipe and required packages) - --time, -T Print execution time for every action - --format, -f format Output format (tap13|tap14|json|xml) - --dir, -d dir Path to working directory - --path, -p path Path to directory with binaries - --error-dir, -e dir Path to directory for errors data - --tag, -t tag One or more command tags to run - --quiet, -q Quiet mode - --ignore-packages, -ip Do not check system for installed packages - --no-cleanup, -nl Disable deleting files created during tests - --no-color, -nc Disable colors in output - --help, -h Show this help message - --version, -v Show version - -Examples - - bibop app.recipe - Run tests from app.recipe - - bibop app.recipe --quiet --error-dir bibop-errors - Run tests from app.recipe in quiet mode and save errors data to bibop-errors directory - - bibop app.recipe --tag init,service - Run tests from app.recipe and execute commands with tags init and service - - bibop app.recipe --extra - Run tests from app.recipe and print the last 10 lines from command output if action was failed - - bibop app.recipe --extra=50 - Run tests from app.recipe and print the last 50 lines from command output if action was failed - - bibop app.recipe --format json 1> ~/results/app.json - Run tests from app.recipe and save result in JSON format - - sudo dnf install $(bibop app.recipe -L1) - Install all packages required for tests -``` + ### CI Status