search

geerlingguy / rpi-clone

A shell script to clone a booted disk on a Raspberry Pi.
https://rpi-clone.jeffgeerling.com/
BSD 3-Clause "New" or "Revised" License
272 stars 16 forks source link

Maybe set up a little GitHub Pages site with simple instructions? #3

Closed geerlingguy closed 9 months ago

geerlingguy commented 9 months ago

It could be nice to have a little separate site that is managed via GitHub Pages (with the source in this repo) for documentation. Otherwise (and maybe additionally), the README can be reorganized a little to focus on the use case for most users: clone project and install, then clone internal microSD to another volume.

framps commented 9 months ago

Sure. Would be great to document the rpi-clone capabilities from a user point of view. We also should use the GH Pages URL as the landing URL whenever we refer to rpi-clone.

geerlingguy commented 9 months ago

I have it set up with a Jekyll install inside docs, but it seems to be pulling from the main README and not from the Jekyll setup I have running... have to figure out how the github actions workflow runs...

https://rpi-clone.jeffgeerling.com

geerlingguy commented 9 months ago

Well, it's there now! Goal is to make it so people can go from 0-100 quickly.

Maybe we could add in a curl | sudo bash install script too, so it's a one-click install... I don't always like those but they sure are convenient.

Closing this issue for the time being.