Skip to content

Commit 6f1da9e

Browse files
committed
README: Add overview image and improve initial text
Signed-off-by: Richard Alpe <[email protected]>
1 parent d413185 commit 6f1da9e

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11

22
<img align="left" src="logo.png" alt="9pm Logo" width=400>
33

4-
9pm is a flexible and efficient framework for running test cases or suites defined in YAML files or specified via command-line arguments. It supports nested suites, detailed logging, and robust error handling, making it ideal for simply managing complex test setups.
4+
**9pm runs tests in any language without the bloat.** No frameworks to learn, **no exotic dependencies** - just **reliable test execution** and **clear results**.
55

66
---
77

8-
## Features
8+
## Why 9pm
99

10-
- **Arbitrary Test Execution**: Run individual tests or entire suites from the command line.
11-
- **YAML-Defined Suites**: Organize tests in structured, nested YAML files for reusability.
12-
- **Color-Coded Terminal Output**: Easily identify test statuses with intuitive colors.
13-
- **"On-Fail" Logic**: Define custom actions for failed tests to improve debugging.
14-
- **Masked Failures**: Optionally ignore specific test failures or skips without halting the suite.
15-
- **JSON Export**: Export comprehensive test results in JSON format for further processing.
16-
- **Isolated Environment**: Use temporary directories and files for scratch area. Ensuring nothing is left after test execution, even if the test itself crashes.
10+
- **Universal**: Runs any executable - shell scripts, Python, Perl, compiled binaries
11+
- **TAP Protocol**: Handles results from anything that outputs Test Anything Protocol
12+
- **Crash Detection**: Detects and handles tests that crash mid-execution
13+
- **Flexible Execution**: Run individual tests from command line or organized test suites
14+
- **Nested Structure**: Supports complex hierarchical suites with custom options and names
15+
- **Ready Environment**: Provides temporary directories, logging paths, and clean isolation
16+
17+
*Make complex test setups easy while keeping simple tests simple.*
18+
19+
---
20+
21+
## Overview
22+
23+
<img src="doc/overview3.png" alt="9pm Overview" width="1000">
1724

1825
---
1926

@@ -26,7 +33,11 @@
2633
```
2734
2. Install core dependencies:
2835
```bash
29-
pip install pyyaml
36+
# Debian/Ubuntu
37+
sudo apt install python3-yaml
38+
39+
# RHEL/Fedora/CentOS
40+
sudo dnf install python3-pyyaml
3041
```
3142

3243
> [!NOTE]

doc/overview3.png

71.6 KB
Loading

0 commit comments

Comments
 (0)