diff --git a/FAQ.md b/FAQ.md index 65a9ad8..44b7bd5 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,26 +1,43 @@ -1. What screens are supported? +1. ** *X* is broken, can you fix it?!** + Probably, please create a [new issue](https://github.com/jpmck/PADD/issues/new/choose) on the repo for me to look at it. - PADD has only been "officially" tested on a 3.5" PiTFT display. It also works on any terminal emulator (Terminal.app, iTerm, PuTTY, etc.). It has also been in use by other users on several other third-party displays. +2. **Can you add *X* to PADD?** + Maybe… please create a [new issue](https://github.com/jpmck/PADD/issues/new/choose) on the repo for me to look at it. -2. What version of Pi-hole is supported? +3. **I think I fixed *X*. Can I add it to PADD?** + Sure, make a new Pull request and I’ll take a look. + +4. **What screens are supported?** + + PADD has only been “officially” tested on a 3.5" PiTFT display. It also works on any terminal emulator (Terminal.app, iTerm, PuTTY, etc.). It has also been in use by other users on several other third-party displays. + +5. **What version of Pi-hole is supported?** Generally speaking, the latest version of Pi-hole at the time the a new version of PADD is released. However, if there is an update to Pi-hole, there is a small chance that PADD may break. - - I'm on the beta version of Pi-hole and the display is messed up. Will there be support for the development branch of Pi-hole? + - **I’m on the beta version of Pi-hole and the display is messed up. Will there be support for the development branch of Pi-hole?** - No. My Pi-hole, and by extension my PADD, runs in my house with the following goals: (a) don't screw up the internet for for my work-from-home/VPN setup, and (b) don't screw up the internet for my wife. For those reasons, PADD will only ever support the latest stable release of Pi-hole. + No. My Pi-hole, and by extension my PADD, runs in my house with the following goals: -3. What does PADD mean? + - don’t screw up the internet for for my work-from-home/VPN setup, and + - don’t screw up the internet for my wife (happy wife, happy life). - [Personal Access Display Device](http://memory-alpha.org/wiki/PADD) ... also "Pi-hole Ad Detection Display" ... + For those reasons, PADD will only ever support the latest stable release of Pi-hole. - - "Pi-hole Ad Detection Display"? Does that mean you're part of the Pi-hole team? +6. **What does PADD mean?** - Nope, PADD is a third-party application that isn't affiliated with the official Pi-hole project. + [Personal Access Display Device](http://memory-alpha.org/wiki/PADD)… also “Pi-hole Ad Detection Display”… -4. Who are you? How can I get a hold of you? + - **“Pi-hole Ad Detection Display”? Does that mean you're part of the Pi-hole team?** + + Nope, PADD is a third-party application that isn’t affiliated with the official Pi-hole project. + +7. **Who are you? How can I get a hold of you?** ![Jim](https://jpmck.com/img/yournameisjim.png) Yes, my name is Jim. - You can send me an email at `jim at jpmck dot com` or send me a message on [Reddit](https://reddit.com/user/jpmck). + You can send me a message on [Reddit](https://reddit.com/user/jpmck) or send me an email at + `jim at jpmck dot com`. + + (**Note:** If you’re experiencing a problem with PADD or would like a feature added, please just create a [new issue](https://github.com/jpmck/PADD/issues/new/choose) on the repo.) diff --git a/Home.md b/Home.md index a29e5ee..bb280ec 100644 --- a/Home.md +++ b/Home.md @@ -1,9 +1,4 @@ PADD (formerly Chronometer2) is a more expansive version of the original chronometer.sh that is included with [Pi-Hole](https://pi-hole.net). PADD provides in-depth information about your Pi-hole. PADD is optimized for a 60x22 character display: -![PADD](https://jpmck.com/img/blog/padd.png) - -It will also run in PADDmini mode on a screen that is smaller than 60x22 characters: -![PADDmini](https://jpmck.com/img/blog/paddmini.png) - -(PADD will not run on a screen smaller than 30x16.) +![PADD](https://jpmck.com/img/padd/6regular.png) However, it will run in several other sizes below that as well! (See [“Sizes”](https://github.com/jpmck/PADD/wiki/Sizes).) (Note: PADD will not run on a screen smaller than 20x10.) diff --git a/Known Issues.md b/Known Issues.md new file mode 100644 index 0000000..a94f2ad --- /dev/null +++ b/Known Issues.md @@ -0,0 +1,11 @@ +### PADD tells me Pi-hole is out-of-date when it’s not. + +**Issue:** +PADD will show that one or all parts of Pi-hole are out-of-date. + +**Workaround** +- Exit PADD by hitting `Ctrl+C` twice. +- Delete the piHoleVersion file with: + `rm piHoleVersion` +- Restart PADD with: + `./padd.sh` diff --git a/Sizes.md b/Sizes.md new file mode 100644 index 0000000..a6caec4 --- /dev/null +++ b/Sizes.md @@ -0,0 +1,61 @@ +PADD will display on screens that anywhere from 20x10 characters to over 60x22 characters. + +PADD is optimized for a 60x22 character display and will give you the most information at this size. As your screen gets smaller, you’ll be presented with less information… however, you’ll always get the most important details: +- The status of your Pi-hole (is it online, in need of an update?), +- How many ads have been blocked, +- Your hostname and IP, and +- Your CPU’s current load. + +It will also run in the following modes (shown further below): +- Pico +- Nano +- Micro +- Mini +- Slim +- Regular + +## Sizing Your PADD +How PADD will display on your screen depends on the size of the screen in *characters*, not *pixels*! PADD doesn’t care if it is running on a 5k Retina display on your $5,000 iMac Pro or on a $5 display you bought on eBay. + +If you want to change how PADD displays on a small display attached to your Raspberry Pi, use +```bash +sudo dpkg-reconfigure console-setup +``` +to configure your font settings to an ideal size for you. + +If you want to change how PADD displays through a terminal emulator (PuTTY, Terminal.app, iTerm2, etc.), resize your window or play with font sizes in your app of choice. + +## The Sizes + +The first three sizes are the “SI unit” sizes. You can tell which version is running based on the prefix *before* the PADD logo at the top of the display. + +The second three sizes are the two “original” PADD sizes (mini and regular) as well as a modified regular version (slim). You can tell which version is running based on the name *after* the PADD logo. + +### Pico +![PADD](https://jpmck.com/img/padd/1pico.png) +Pico (p) is 20x10 characters. + +### Nano +![PADD](https://jpmck.com/img/padd/2nano.png) +Nano (n) is 24x12 characters. + +### Micro +![PADD](https://jpmck.com/img/padd/3micro.png) +Micro (µ) is 24x12 characters. + +### Mini +![PADD](https://jpmck.com/img/padd/4mini.png) +Mini is 30x16 characters. +Chronometer2’s baby. + +### Slim +![PADD](https://jpmck.com/img/padd/5slim.png) +Slim is 60x20 characters. + +Slim should be helpful for some users with with screens that are a little short (see the cut off logo [here](https://imgur.com/a/AU4IO1e) for example.) + +### Regular +![PADD](https://jpmck.com/img/padd/6regular.png) +Regular is 60x22 characters. + +The OG Chronometer2! Regular takes up the entire screen on a 3.5" Adafruit PiTFT using the Terminus font at 8x14.