Skip to content

Commit

Permalink
Update README with more specific requirements (#1856)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
db39 authored Nov 20, 2024
1 parent 61e9142 commit 66d3d02
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](LICENSE)
[![Contributors](https://img.shields.io/github/contributors/tiny-pilot/tinypilot)](https://github.com/tiny-pilot/tinypilot/graphs/contributors)
[![CircleCI](https://circleci.com/gh/tiny-pilot/tinypilot.svg?style=svg)](https://circleci.com/gh/tiny-pilot/tinypilot)
[![Reddit](https://img.shields.io/badge/reddit-join-orange?logo=reddit)](https://www.reddit.com/r/tinypilot)
[![Twitter](https://img.shields.io/twitter/follow/tinypilotkvm?label=Twitter&style=social)](https://twitter.com/tinypilotkvm)

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

## Build your own

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

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.

## Pre-requisites
## Simple installation

- Raspberry Pi OS Bullseye (32-bit)
- python3-venv
### Requirements

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

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

Expand Down

0 comments on commit 66d3d02

Please sign in to comment.