From 86aff645dc1adf97b6427b356592f80b080483e3 Mon Sep 17 00:00:00 2001 From: Jarno Rantanen Date: Wed, 7 Nov 2018 10:37:52 +0200 Subject: [PATCH] Use Prettier to format the Markdown. --- README.md | 48 +++++++++++++++++++++-------------------- docs/first-boot.md | 22 +++++++++---------- docs/verified-models.md | 24 ++++++++++----------- 3 files changed, 48 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 00f0596..c4223d3 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,16 @@ Easy-to-use **Raspberry Pi** image for booting directly into **full-screen Chrom startup graphics getting started -guide is just one keypress away ``` -* **Boots directly to full-screen Chrome** - with all the features of a modern browser -* **No automatic updates** - no surprises due to Chrome (or other packages) suddenly updating -* **Automatic crash-recovery** - accidental unpowering won't result in "Chrome did not shut down correctly :(" -* **Custom startup graphics** - displays [customizable graphics](home/background.png) instead of console messages during startup -* **Lightweight window manager** - uses [Matchbox](https://www.yoctoproject.org/tools-resources/projects/matchbox) for minimal clutter and memory footprint -* **HDMI output control** - ready-made scripts for [turning off the display](home/crontab.example) outside of office hours, for example -* **Cursor hiding** - if you leave a mouse plugged in, the cursor is hidden after a brief period of inactivity -* **Automatic reboots** - reboots the Pi nightly, when nobody's watching, to keep it running smoothly -* **Based on a recent Debian** - if you want to add your own tweaks, all the expected packages are one `apt-get` away -* **Batteries included** - the most common how-to's and ProTips have been collected to the [first-boot document](docs/first-boot.md) +- **Boots directly to full-screen Chrome** - with all the features of a modern browser +- **No automatic updates** - no surprises due to Chrome (or other packages) suddenly updating +- **Automatic crash-recovery** - accidental unpowering won't result in "Chrome did not shut down correctly :(" +- **Custom startup graphics** - displays [customizable graphics](home/background.png) instead of console messages during startup +- **Lightweight window manager** - uses [Matchbox](https://www.yoctoproject.org/tools-resources/projects/matchbox) for minimal clutter and memory footprint +- **HDMI output control** - ready-made scripts for [turning off the display](home/crontab.example) outside of office hours, for example +- **Cursor hiding** - if you leave a mouse plugged in, the cursor is hidden after a brief period of inactivity +- **Automatic reboots** - reboots the Pi nightly, when nobody's watching, to keep it running smoothly +- **Based on a recent Debian** - if you want to add your own tweaks, all the expected packages are one `apt-get` away +- **Batteries included** - the most common how-to's and ProTips have been collected to the [first-boot document](docs/first-boot.md) ## Getting started @@ -42,23 +42,25 @@ The Pi needs a [2.5 Amp power source](https://www.raspberrypi.org/documentation/ ## Optional features ### rotate screen: portrait and landscape mode -* Hit CTRL-ALT-F1 then choose finish to go to console -* sudo nano /boot/config.txt -* move all the way down to the end of the file -* to rotate 90° clockwise, add the line: display_rotate=1 -* Press ctrl + o to save and ctrl + x to exit the file - + +- Hit CTRL-ALT-F1 then choose finish to go to console +- sudo nano /boot/config.txt +- move all the way down to the end of the file +- to rotate 90° clockwise, add the line: display_rotate=1 +- Press ctrl + o to save and ctrl + x to exit the file + Now do a reboot (sudo reboot) and you should have a screen tilted: -* 0 = 0 degrees (the default value) -* 1 = 90 degrees -* 2 = 180 degrees -* 3 = 270 degrees + +- 0 = 0 degrees (the default value) +- 1 = 90 degrees +- 2 = 180 degrees +- 3 = 270 degrees ## Common issues -* **I get a kernel panic on boot, or the image keeps crashing.** The Raspberry Pi is somewhat picky about about its SD cards. It's also possible the SD card has a bad sector in a critical place, and `dd` wasn't be able to tell you. Double-check that you're using [a blessed SD card](http://elinux.org/RPi_SD_cards), and try flashing the image again. -* **I see a "rainbow square" or "yellow lightning" in the top right corner of the screen, and the device seems unstable.** This usually means the Pi isn't getting enough amps from your power supply. This is sometimes the case in more exotic setups (e.g. using the USB port of your display to power the Pi) or with cheap power supplies. Try another one. -* **The [display control scripts](home/display-on.sh) don't turn off the display device.** Normal PC displays will usually power down when you cut off the signal, but this is not the case for many TV's. Please check if your TV has an option in its settings for enabling this, as some do. If not, you can [try your luck with HDMI CEC signals](http://raspberrypi.stackexchange.com/questions/9142/commands-for-using-cec-client), but the TV implementations of the spec are notoriously spotty. +- **I get a kernel panic on boot, or the image keeps crashing.** The Raspberry Pi is somewhat picky about about its SD cards. It's also possible the SD card has a bad sector in a critical place, and `dd` wasn't be able to tell you. Double-check that you're using [a blessed SD card](http://elinux.org/RPi_SD_cards), and try flashing the image again. +- **I see a "rainbow square" or "yellow lightning" in the top right corner of the screen, and the device seems unstable.** This usually means the Pi isn't getting enough amps from your power supply. This is sometimes the case in more exotic setups (e.g. using the USB port of your display to power the Pi) or with cheap power supplies. Try another one. +- **The [display control scripts](home/display-on.sh) don't turn off the display device.** Normal PC displays will usually power down when you cut off the signal, but this is not the case for many TV's. Please check if your TV has an option in its settings for enabling this, as some do. If not, you can [try your luck with HDMI CEC signals](http://raspberrypi.stackexchange.com/questions/9142/commands-for-using-cec-client), but the TV implementations of the spec are notoriously spotty. ## Acknowledgements diff --git a/docs/first-boot.md b/docs/first-boot.md index 4cb4393..6df64f8 100644 --- a/docs/first-boot.md +++ b/docs/first-boot.md @@ -14,11 +14,11 @@ Chromium is configured to remember the URL where you left off (and all logins, e You can access the `raspi-config` utility by pressing `Ctrl + Alt + F2`. With it, you can do things like: -* Join a WiFi network -* Change your keyboard layout -* Change the system timezone -* Enable SSH access (it's disabled by default for security reasons) -* Change the password (see above) +- Join a WiFi network +- Change your keyboard layout +- Change the system timezone +- Enable SSH access (it's disabled by default for security reasons) +- Change the password (see above) Pressing `Ctrl + Alt + F1` takes you back to Chromium. @@ -26,10 +26,10 @@ Pressing `Ctrl + Alt + F1` takes you back to Chromium. There's a few commonly useful snippets already on the crontab, such as: -* **Rebooting the Pi every night at 3 AM**. If you run resource intensive pages on your dashboard, the Pi can eventually start to slow down. A nightly reboot keeps it rested and refreshed! This is enabled by default. -* **Turning the display off for the night**. This helps save energy when there's no-one there to look at your dashboard. Sometimes also useful for reasons of vanity, when bright displays in the middle of a dark office would look ridiculous. Do make sure your display/television comes back on, however: especially older TV's sometimes won't know to automatically turn back on when the HDMI signal comes back on. In those cases, you may have luck with [CEC signals](https://timleland.com/raspberry-pi-turn-tv-onoff-cec/), but also you may not. If nothing else works, you can always just [blank the display](https://askubuntu.com/a/7299). -* **Automatically reloading the active page every hour**. If the page you're displaying doesn't automatically update itself, this is effectively the same as hitting `Ctrl + R` every hour. Very crude. Very effective. -* **Cycling between open tabs every 5 minutes**. Same as above, but for `Ctrl + Tab`. Note that if you use both at the same time, you can combine them, to send the reload command *just before* sending the tab cycle command. This causes the pages to reload while they're in the background, so the user never sees it happening. +- **Rebooting the Pi every night at 3 AM**. If you run resource intensive pages on your dashboard, the Pi can eventually start to slow down. A nightly reboot keeps it rested and refreshed! This is enabled by default. +- **Turning the display off for the night**. This helps save energy when there's no-one there to look at your dashboard. Sometimes also useful for reasons of vanity, when bright displays in the middle of a dark office would look ridiculous. Do make sure your display/television comes back on, however: especially older TV's sometimes won't know to automatically turn back on when the HDMI signal comes back on. In those cases, you may have luck with [CEC signals](https://timleland.com/raspberry-pi-turn-tv-onoff-cec/), but also you may not. If nothing else works, you can always just [blank the display](https://askubuntu.com/a/7299). +- **Automatically reloading the active page every hour**. If the page you're displaying doesn't automatically update itself, this is effectively the same as hitting `Ctrl + R` every hour. Very crude. Very effective. +- **Cycling between open tabs every 5 minutes**. Same as above, but for `Ctrl + Tab`. Note that if you use both at the same time, you can combine them, to send the reload command _just before_ sending the tab cycle command. This causes the pages to reload while they're in the background, so the user never sees it happening. Press `Ctrl + Alt + F3` to get to a virtual terminal, use `crontab -e` to check these out, enable the ones you want, or customize them to your heart's content. @@ -39,8 +39,8 @@ Again, pressing `Ctrl + Alt + F1` takes you back to Chromium. Because you're running a fully-featured Chromium, you can customize it further by [installing browser extensions](https://chrome.google.com/webstore/category/extensions). For example: -* **[Tampermonkey](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo)** can be useful for injecting custom JS or CSS to a page you're displaying. -* **[Ignore X-Frame headers](https://chrome.google.com/webstore/detail/ignore-x-frame-headers/gleekbfjekiniecknbkamfmkohkpodhe)** can help you if you need to `