From 761c4ff8532fb3ef60d952330642923bfd7cf67d Mon Sep 17 00:00:00 2001 From: Jeff Geerling Date: Tue, 13 Feb 2024 12:04:53 -0600 Subject: [PATCH] PR #6 Follow-up: Update docs site and slightly clean up README. --- README.md | 28 +++++++++++++++------------- docs/_includes/header.html | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 13 deletions(-) create mode 100644 docs/_includes/header.html diff --git a/README.md b/README.md index 3e25279..7faa8d2 100644 --- a/README.md +++ b/README.md @@ -46,26 +46,28 @@ only Debian packages with apt-get. #### On a Raspberry Pi: ``` - Either - $ curl https://github.com/geerlingguy/rpi-clone/blob/master/install | sudo bash +$ curl https://github.com/geerlingguy/rpi-clone/blob/master/install | sudo bash +``` - or - $ git clone https://github.com/geerlingguy/rpi-clone.git - $ cd rpi-clone - $ sudo cp rpi-clone rpi-clone-setup /usr/local/sbin +You can also manually clone the project and copy the scripts into place, if you don't want to use the `curl | sudo bash` install method: + +``` +$ git clone https://github.com/geerlingguy/rpi-clone.git +$ cd rpi-clone +$ sudo cp rpi-clone rpi-clone-setup /usr/local/sbin ``` -Make sure /usr/local/sbin is in your $PATH and then run -rpi-clone or rpi-clone-setup with no args to print usage. +Make sure `/usr/local/sbin` is in your $PATH and then run +`rpi-clone` or `rpi-clone-setup` with no args to print usage. -rpi-clone-setup is for setting the hostname in /etc/hostname and /etc/hosts -files. It is run automatically by rpi-clone if -s args are given, -but before your first clone using a -s option, test run rpi-clone-setup with: +`rpi-clone-setup` is for setting the hostname in `/etc/hostname` and `/etc/hosts` +files. It is run automatically by `rpi-clone` if `-s` args are given, +but before your first clone using a `-s` option, test run `rpi-clone-setup` with: ``` $ sudo rpi-clone-setup -t testhostname ``` -And check the files under /tmp/clone-test to be sure the files have been +And check the files under `/tmp/clone-test` to be sure the files have been edited correctly. If you need additional customizations to a clone, -add them to the rpi-clone-setup script. +add them to the `rpi-clone-setup` script. #### On other OS: To install on another OS, rpi-clone may be renamed to suit. For example, diff --git a/docs/_includes/header.html b/docs/_includes/header.html new file mode 100644 index 0000000..349ffbb --- /dev/null +++ b/docs/_includes/header.html @@ -0,0 +1,33 @@ +
+ +
+ {%- assign default_paths = site.pages | map: "path" -%} + {%- assign page_paths = site.header_pages | default: default_paths -%} + {%- assign titles_size = 1 -%} + + + {%- if titles_size > 0 -%} + + {%- endif -%} +
+