Skip to content

Commit

Permalink
PR #6 Follow-up: Update docs site and slightly clean up README.
Browse files Browse the repository at this point in the history
  • Loading branch information
geerlingguy committed Feb 13, 2024
1 parent 5fb247b commit 761c4ff
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
33 changes: 33 additions & 0 deletions docs/_includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<header class="site-header">

<div class="wrapper">
{%- assign default_paths = site.pages | map: "path" -%}
{%- assign page_paths = site.header_pages | default: default_paths -%}
{%- assign titles_size = 1 -%}
<a class="site-title" rel="author" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>

{%- if titles_size > 0 -%}
<nav class="site-nav">
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger">
<span class="menu-icon">
<svg viewBox="0 0 18 15" width="18px" height="15px">
<path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
</svg>
</span>
</label>

<div class="trigger">
<a class="page-link" href="/">Home</a>
<a class="page-link" href="https://github.com/geerlingguy/rpi-clone">Source Code</a>
{%- for path in page_paths -%}
{%- assign my_page = site.pages | where: "path", path | first -%}
{%- if my_page.title -%}
<a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
{%- endif -%}
{%- endfor -%}
</div>
</nav>
{%- endif -%}
</div>
</header>

0 comments on commit 761c4ff

Please sign in to comment.