Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Commit 4f6202a

Browse files
kirkbrauerkirkbrauer
authored
Add additional content to README (#405)
* Add badges to README * Update Jumpstarter badge * Update README badges * Update Jumpstarter badge JSON * Replace high voltage emoji with custom bolt * Add more README sections * Add links to documentation and fix preview image * Change badge source
1 parent 62a5c41 commit 4f6202a

4 files changed

Lines changed: 66 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 53 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,55 @@
1-
# Jumpstarter
1+
# ![bolt](./assets/bolt.svg) Jumpstarter
22

3-
A Python framework and CLI tool for Hardware in the Loop automation and development.
3+
[![badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/jumpstarter-dev/jumpstarter/main/assets/badge/v0.json)](https://github.com/jumpstarter-dev/jumpstarter)
4+
[![ci](https://img.shields.io/github/actions/workflow/status/jumpstarter-dev/jumpstarter/build.yaml?branch=main&logo=github&label=CI)](https://github.com/jumpstarter-dev/jumpstarter/actions)
5+
[![release](https://img.shields.io/github/v/release/jumpstarter-dev/jumpstarter)](https://github.com/jumpstarter-dev/jumpstarter/releases)
6+
[![versions](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fjumpstarter-dev%2Fjumpstarter%2Fmain%2Fpackages%2Fjumpstarter%2Fpyproject.toml)](https://github.com/jumpstarter-dev/jumpstarter/blob/main/packages/jumpstarter/pyproject.toml)
7+
[![license](https://img.shields.io/github/license/jumpstarter-dev/jumpstarter)](https://github.com/jumpstarter-dev/jumpstarter/blob/main/LICENSE)
8+
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
49

5-
For comprehensive documentation, visit [docs.jumpstarter.dev](https://docs.jumpstarter.dev)
10+
An open source and cloud native Hardware-in-the-Loop testing tool that enables you to test your software stack on both real hardware and virtual environments using CI/CD principles.
11+
12+
## Highlights
13+
14+
- 🚀 A single, unified testing tool for local, virtual, and remote hardware testing.
15+
- 🐍 Write test scripts in Python with familiar frameworks such as [pytest](https://docs.pytest.org/en/stable/).
16+
- 🛠️ Use [drivers](https://docs.jumpstarter.dev/introduction/drivers.html) to abstract complex hardware interfaces for testing.
17+
- 🔌 Built-in support for common interfaces such as [CAN](https://github.com/jumpstarter-dev/jumpstarter/tree/main/packages/jumpstarter-driver-can), [IP](https://github.com/jumpstarter-dev/jumpstarter/tree/main/packages/jumpstarter-driver-network), [GPIO](https://github.com/jumpstarter-dev/jumpstarter/tree/main/packages/jumpstarter-driver-raspberrypi), [U-Boot](https://github.com/jumpstarter-dev/jumpstarter/tree/main/packages/jumpstarter-driver-uboot), [SD Wire](https://github.com/jumpstarter-dev/jumpstarter/tree/main/packages/jumpstarter-driver-sdwire), etc.
18+
- 💻 Collaborate with developers around the world on shared test hardware.
19+
- ☸ Integrates with your existing [Cloud Native](https://www.cncf.io/) development environment.
20+
- 🔄 Run hardware tests with your existing CI/CD pipelines in the cloud.
21+
- 📦 Support for containerized test runners with Podman/Docker.
22+
- 🖥️ Supports Linux and macOS.
23+
24+
## Installation
25+
26+
Install all the Jumpstarter Python components:
27+
28+
```console
29+
pip install --extra-index-url https://docs.jumpstarter.dev/packages/simple jumpstarter-all
30+
```
31+
32+
Or, just install the `jmp` CLI tool:
33+
34+
```console
35+
pip install --extra-index-url https://docs.jumpstarter.dev/packages/simple jumpstarter-cli
36+
```
37+
38+
To install the [Jumpstarter Service](https://docs.jumpstarter.dev/introduction/service.html)
39+
in your Kubernetes cluster, see the [Service Installation](https://docs.jumpstarter.dev/installation/service/index.html)
40+
documentation.
41+
42+
## Documentation
43+
44+
Jumpstarter's documentation is available at [docs.jumpstarter.dev](https://docs.jumpstarter.dev).
45+
46+
Additionally, the command line reference documentation can be viewed with `jmp --help`.
47+
48+
## Contributing
49+
50+
Jumpstarter welcomes contributors of all levels of experience and would love to
51+
see you involved in the project. See the [contributing guide](https://github.com/jumpstarter-dev/jumpstarter/blob/main/CONTRIBUTING.md) to get started.
52+
53+
## License
54+
55+
Jumpstarter is licensed under the Apache 2.0 License ([LICENSE](https://github.com/jumpstarter-dev/jumpstarter/blob/main/LICENSE) or [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)).

‎assets/badge/v0.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "",
3+
"message": "Jumpstarter",
4+
"logoSvg": "<svg width=\"290\" height=\"364\" viewBox=\"0 0 290 364\" fill=\"none\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M87.4922 213.67L87.54 213.273C87.8813 211.567 87.54 210.201 86.516 209.177C85.492 207.812 84.1267 207.129 82.42 207.129H11.764C10.0573 207.129 8.52133 207.812 7.156 209.177C6.132 210.201 5.44933 211.567 5.108 213.273L1.524 243.481C0.841333 251.673 0.5 257.476 0.5 260.889C0.5 291.951 10.74 316.868 31.22 335.641C52.0413 354.073 80.2013 363.289 115.7 363.289C140.959 363.289 163.999 358.34 184.82 348.441C205.983 338.201 223.049 324.036 236.02 305.945C249.332 287.855 257.353 267.033 260.084 243.481L289.268 6.93726C289.609 5.2306 289.268 3.86526 288.244 2.84125C287.22 1.47592 285.855 0.793248 284.148 0.793248H214.004C212.297 0.793248 210.761 1.47592 209.396 2.84125C208.372 3.86526 207.689 5.2306 207.348 6.93726L193.792 116.572H220.092C246.576 116.572 261.596 146.906 245.543 167.969L115.175 339.02C97.0479 362.804 59.2615 345.422 65.527 316.181L87.4922 213.67Z\" fill=\"#212121\"\/><path d=\"M176.077 1.9222L33.0388 169.149C28.5986 174.34 32.2873 182.349 39.1182 182.349H108.852C113.945 182.349 117.742 187.045 116.675 192.025L88.9944 321.209C88.0993 325.386 93.4973 327.87 96.0869 324.472L226.455 153.421C230.468 148.155 226.713 140.572 220.092 140.572H153.88C148.537 140.572 144.696 135.435 146.207 130.31L182.954 5.65327C184.174 1.515 178.882 -1.35638 176.077 1.9222Z\" fill=\"#FFC107\"\/><\/svg>",
5+
"logoWidth": 10,
6+
"labelColor": "#E9E9E9",
7+
"color": "#FFC107"
8+
}

‎assets/bolt.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,5 +95,5 @@
9595
# Patterns for the versions panel
9696
html_context = {
9797
"display_lower": True, # Display lower versions at the bottom of the menu
98-
"deploy_url": os.getenv("DEPLOY_URL", "http://localhost:8000"), # Get Netlify URL from environment variable
98+
"deploy_url": os.getenv("DEPLOY_URL", "https://docs.jumpstarter.dev"), # Get Netlify URL from environment variable
9999
}

0 commit comments

Comments
 (0)