diff --git a/README.md b/README.md index 53d80a9..f45891d 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,66 @@ # PaperPi -PaperPi shows information on an e-paper screen attached to a Raspberry Pi: clocks, the weather, your calendar, what music is playing, comics, public transport departures and more. You set it up in a web page on your phone or computer. +PaperPi is a lovely, quiet, slow internet e-Paper radio. No loud colors, no busy animations, just a lovely selection of the information you want without buzz and distraction. PaperPi rotates through your choice of plugin screens at the pace you choose. + +Clocks, the weather, your calendar, what music is playing, comics, public transport departures and more, on an e-paper screen attached to a Raspberry Pi. You set it up in a web page on your phone or computer. **The manual: ** -## Version 1 is no longer maintained +| | | | | +|---|---|---|---| +| ![Word clock](tests/images/word_clock-words_time-9in7.png) | ![Weather](tests/images/met_no-hours_12-9in7.png) | ![Moon phase](tests/images/moon_phase-moon_data-9in7.png) | ![xkcd comic](tests/images/xkcd_comic-comic_title_alttext-9in7.png) | +| [Word clock](https://txoof.github.io/PaperPi/plugins/word_clock/) | [Weather](https://txoof.github.io/PaperPi/plugins/met_no/) | [Moon phase](https://txoof.github.io/PaperPi/plugins/moon_phase/) | [xkcd comic](https://txoof.github.io/PaperPi/plugins/xkcd_comic/) | -This branch (`main`) holds PaperPi **version 2**, a rewrite from scratch. Version 1 gets no fixes, and version 2 does not read its config files. Its code stays on the [`v1` branch](https://github.com/txoof/PaperPi/tree/v1), with the last state marked by the tag [`v1-final`](https://github.com/txoof/PaperPi/tree/v1-final). +All plugins, with pictures and their settings: [Plugins](https://txoof.github.io/PaperPi/plugins/). + +## What you need + +- A Raspberry Pi 3 or newer with Raspberry Pi OS "trixie", on your home network. +- An e-paper screen: one with Waveshare's IT8951 board (such as the Waveshare 9.7") or one of Waveshare's small screens on the e-Paper HAT. Which ones work: [Supported screens](https://txoof.github.io/PaperPi/screens/). +- An internet connection for the plugins that fetch information, such as the weather. + +How to connect the screen: [Hardware](https://txoof.github.io/PaperPi/hardware/). + +## Install + +1. Log in to the Pi, with a keyboard and screen or from another computer with SSH (`ssh @`). +2. Run this command. It downloads the install script and runs it as administrator: -## Install on a Raspberry Pi + ```bash + curl -fsSL https://raw.githubusercontent.com/txoof/PaperPi/main/install/paperpi-install | sudo bash + ``` -PaperPi needs a Raspberry Pi 3 or 4 with Raspberry Pi OS "trixie", and a screen with Waveshare's IT8951 board (such as the Waveshare 9.7") or one of Waveshare's small screens. One command installs PaperPi as a systemd service (it starts with the Pi and is started again after a crash). It asks which screen is connected: +3. Answer its questions: which screen is connected and its size. Then wait a few minutes while it installs PaperPi and starts it. PaperPi then starts by itself every time the Pi starts. +4. The screen shows a QR code and a web address. Scan the code with your phone or type the address into a browser on the same network, and choose what the screen shows. + +Every question explained, and installing without questions: [Install](https://txoof.github.io/PaperPi/install/). The first steps in the web page: [First Setup](https://txoof.github.io/PaperPi/first-setup/). + +To update to the newest version later: ```bash -curl -fsSL https://raw.githubusercontent.com/txoof/PaperPi/main/install/paperpi-install | sudo bash +sudo paperpi-install update ``` -What you need, the install step by step, and how to update and remove PaperPi: [Install](https://txoof.github.io/PaperPi/install/). +## The manual + +| Page | What it covers | +|---|---| +| [Hardware](https://txoof.github.io/PaperPi/hardware/) | Which Pi and screen, and how to connect them | +| [Install](https://txoof.github.io/PaperPi/install/) | The install, step by step | +| [First Setup](https://txoof.github.io/PaperPi/first-setup/) | Choosing what the screen shows | +| [Web Interface](https://txoof.github.io/PaperPi/web-interface/) | Every page of the web interface | +| [Plugins](https://txoof.github.io/PaperPi/plugins/) | All plugins and their settings | +| [Understanding Plugin Schedules](https://txoof.github.io/PaperPi/take-turns/) | How plugins take turns on the screen | +| [Update and Uninstall](https://txoof.github.io/PaperPi/update/) | Getting a new version, going back, removing PaperPi | +| [Troubleshooting](https://txoof.github.io/PaperPi/troubleshooting/) | What to do when the screen or web page does not work | +| [What's New](https://txoof.github.io/PaperPi/changelog/) | The changes in each release | +| [Writing plugins](https://txoof.github.io/PaperPi/writing-plugins/) | Making a plugin of your own | + +![The Home page of PaperPi's web interface](docs/images/web/home-light.png) + +## Version 1 is no longer maintained + +This branch (`main`) holds PaperPi **version 2**, a rewrite from scratch. Version 1 gets no fixes, and version 2 does not read its config files. Its code stays on the [`v1` branch](https://github.com/txoof/PaperPi/tree/v1), with the last state marked by the tag [`v1-final`](https://github.com/txoof/PaperPi/tree/v1-final). ## Development diff --git a/pyproject.toml b/pyproject.toml index 9fd7f84..247f40a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "paperpi" -version = "2.0.0b1" +version = "2.0.0" description = "Show information on e-paper displays attached to a Raspberry Pi" readme = "README.md" requires-python = ">=3.13" diff --git a/uv.lock b/uv.lock index ad857c0..a4f5b53 100644 --- a/uv.lock +++ b/uv.lock @@ -610,7 +610,7 @@ wheels = [ [[package]] name = "paperpi" -version = "2.0.0b1" +version = "2.0.0" source = { editable = "." } dependencies = [ { name = "epdlib" },