Skip to content

Commit 66d3d02

Browse files
authored
Update README with more specific requirements (#1856)
Resolves #1855 This change updates our README to be more clear with installation requirements. The "pre-requisites" section is now a "requirements" under the "Simple installation" heading. This change also removes the Reddit link shield that links to the unused TinyPilot subreddit. <a data-ca-tag href="https://codeapprove.com/pr/tiny-pilot/tinypilot/1856"><img src="https://codeapprove.com/external/github-tag-allbg.png" alt="Review on CodeApprove" /></a>
1 parent 61e9142 commit 66d3d02

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](LICENSE)
44
[![Contributors](https://img.shields.io/github/contributors/tiny-pilot/tinypilot)](https://github.com/tiny-pilot/tinypilot/graphs/contributors)
55
[![CircleCI](https://circleci.com/gh/tiny-pilot/tinypilot.svg?style=svg)](https://circleci.com/gh/tiny-pilot/tinypilot)
6-
[![Reddit](https://img.shields.io/badge/reddit-join-orange?logo=reddit)](https://www.reddit.com/r/tinypilot)
76
[![Twitter](https://img.shields.io/twitter/follow/tinypilotkvm?label=Twitter&style=social)](https://twitter.com/tinypilotkvm)
87

98
## Overview
@@ -34,7 +33,7 @@ Voyager 2a is TinyPilot's professional-grade KVM over IP device. Its quiet, comp
3433

3534
## Build your own
3635

37-
- [Raspberry Pi 4](https://smile.amazon.com/dp/B07TD42S27) (all variants work)
36+
- [Raspberry Pi 4B](https://smile.amazon.com/dp/B07TD42S27)
3837
- [HDMI to USB dongle](https://smile.amazon.com/dp/B08CXWPYQ8/)
3938
- They have no brand name, and there are several variants, but they're all built on the same MacroSilicon 2109 chip.
4039
- They're available for \$10-15 on eBay and AliExpress.
@@ -51,12 +50,11 @@ Voyager 2a is TinyPilot's professional-grade KVM over IP device. Its quiet, comp
5150

5251
See ["TinyPilot: Build a KVM Over IP for Under \$100"](https://mtlynch.io/tinypilot/#how-to-build-your-own-tinypilot) for a more detailed tutorial on how to assemble these parts to create a TinyPilot.
5352

54-
## Pre-requisites
53+
## Simple installation
5554

56-
- Raspberry Pi OS Bullseye (32-bit)
57-
- python3-venv
55+
### Requirements
5856

59-
## Simple installation
57+
- A Raspberry Pi 4B running Raspberry Pi OS Bullseye (32-bit)
6058

6159
You can install TinyPilot on a compatible Raspberry Pi in just two commands.
6260

0 commit comments

Comments
 (0)