piframe/README.md

# PiFrame

This repo contains everything you need to build a digital Photo Frame using a Raspberry Pi

# Project Status

This is very much a Work In Progress project. Early prototype builds based on rough documenation (see [notes.txt](notes.txt) and [docs/](docs/) are online and being tested.

Additional tuning, documentation and integrations will be added to the repo over time.

# IMPORTANT CONSIDERATIONS

## SSL Support

The PiFrame project does **NOT** use SSL for anything unless it's a default setting for a given service. We have optimized the project to be managed via a trusted LAN and/or VPN solution (for multiple frames).

Use acme.sh + vhosts + nginx if you really want SSL. There is plenty of great information online how to set up acme.sh + nginx + vhosts + SSL if you want to go this route.

We will not discuss, entertain or bother debating our decision regarding SSL. It's an additional layer of complexity and not strictly required for the purposes of this project.

# Bill Of Materials / Hardware Requirements

Please see [hardware.md](hardware.md) for details regarding hardware selection and requirements.

# Licensing

Unless otherwise stated all source code is licensed under the [Apache 2 License](LICENSE-APACHE-2.0.txt).

Unless otherwise stated the non source code contents of this repository are licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](LICENSE-CC-Attribution-NonCommercial-ShareAlike-4.0-International.txt)
Initial bring up 2020-07-31 22:59:41 +00:00			`# PiFrame`

			`This repo contains everything you need to build a digital Photo Frame using a Raspberry Pi`

Tweak readme with project status 2020-07-31 23:07:53 +00:00			`# Project Status`

Tweak main readme for readability and better links to information 2020-07-31 23:32:59 +00:00			`This is very much a Work In Progress project. Early prototype builds based on rough documenation (see [notes.txt](notes.txt) and [docs/](docs/) are online and being tested.`
Tweak readme with project status 2020-07-31 23:07:53 +00:00
			`Additional tuning, documentation and integrations will be added to the repo over time.`

Move base firmware bootstrap from notes to proper markdown document 2020-07-31 23:32:08 +00:00			`# IMPORTANT CONSIDERATIONS`

			`## SSL Support`

			`The PiFrame project does NOT use SSL for anything unless it's a default setting for a given service. We have optimized the project to be managed via a trusted LAN and/or VPN solution (for multiple frames).`

			`Use acme.sh + vhosts + nginx if you really want SSL. There is plenty of great information online how to set up acme.sh + nginx + vhosts + SSL if you want to go this route.`

			`We will not discuss, entertain or bother debating our decision regarding SSL. It's an additional layer of complexity and not strictly required for the purposes of this project.`

Add basic notes about hardware / bom 2020-08-01 00:48:18 +00:00			`# Bill Of Materials / Hardware Requirements`

			`Please see [hardware.md](hardware.md) for details regarding hardware selection and requirements.`

Initial bring up 2020-07-31 22:59:41 +00:00			`# Licensing`

Fixup licencing links / markup 2020-07-31 23:12:07 +00:00			`Unless otherwise stated all source code is licensed under the [Apache 2 License](LICENSE-APACHE-2.0.txt).`
Initial bring up 2020-07-31 22:59:41 +00:00
Fixup licencing links / markup 2020-07-31 23:12:07 +00:00			`Unless otherwise stated the non source code contents of this repository are licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](LICENSE-CC-Attribution-NonCommercial-ShareAlike-4.0-International.txt)`