Skip to content

Commit 06fc8d1

Browse files
committed
README, docs: add one-line setup+install, document required apt update step
1 parent 6c39df6 commit 06fc8d1

2 files changed

Lines changed: 41 additions & 4 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,41 @@ meowtrics --help
7979

8080
## Install via apt repository (recommended for Debian / Ubuntu)
8181

82+
One line. Sets up the signed apt repo if not already added, refreshes the package index, and installs meowtrics. Idempotent, safe to re-run:
83+
84+
```bash
85+
sudo bash -c 'set -e; install -m 0755 -d /etc/apt/keyrings && curl -fsSL https://ra-yavuz.github.io/apt/pubkey.gpg -o /etc/apt/keyrings/ra-yavuz.gpg && echo "deb [signed-by=/etc/apt/keyrings/ra-yavuz.gpg] https://ra-yavuz.github.io/apt stable main" > /etc/apt/sources.list.d/ra-yavuz.list && apt update && apt install -y meowtrics'
86+
systemctl --user enable --now meowtrics
87+
```
88+
89+
If you already added the `ra-yavuz` apt repo earlier, all you need is:
90+
8291
```bash
92+
sudo apt update && sudo apt install meowtrics
93+
```
94+
95+
The `sudo apt update` step is required: without it apt will not see new packages or new versions.
96+
97+
<details><summary>Step by step (manual repo setup)</summary>
98+
99+
```bash
100+
# 1. Trust the signing key
83101
sudo install -m 0755 -d /etc/apt/keyrings
84102
curl -fsSL https://ra-yavuz.github.io/apt/pubkey.gpg \
85103
| sudo tee /etc/apt/keyrings/ra-yavuz.gpg > /dev/null
86104

105+
# 2. Add the apt source
87106
echo "deb [signed-by=/etc/apt/keyrings/ra-yavuz.gpg] https://ra-yavuz.github.io/apt stable main" \
88107
| sudo tee /etc/apt/sources.list.d/ra-yavuz.list
89108

109+
# 3. Refresh the package index, then install
90110
sudo apt update
91111
sudo apt install meowtrics
92112
systemctl --user enable --now meowtrics
93113
```
94114

115+
</details>
116+
95117
## Install single `.deb` from GitHub Releases
96118

97119
No automatic updates with this path.

docs/index.html

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,23 +258,38 @@ <h2 id="messages">Messages</h2>
258258
More cats, funnier lines, more nuanced states.
259259
</p>
260260

261-
<h2>Install via apt repository</h2>
261+
<h2 id="install-quick">Install via apt repository</h2>
262262
<section class="apt-section">
263263
<p>
264-
Add the
264+
One line. Sets up the
265265
<a href="https://ra-yavuz.github.io/apt/">ra-yavuz apt repository</a>
266-
and install with apt. Auto-updates via <code>apt upgrade</code>.
266+
if not already added, refreshes the package index, and installs meowtrics.
267+
Idempotent, safe to re-run. Auto-updates via <code>apt upgrade</code>.
267268
</p>
268-
<pre><code>sudo install -m 0755 -d /etc/apt/keyrings
269+
<pre><code>sudo bash -c 'set -e; install -m 0755 -d /etc/apt/keyrings &amp;&amp; curl -fsSL https://ra-yavuz.github.io/apt/pubkey.gpg -o /etc/apt/keyrings/ra-yavuz.gpg &amp;&amp; echo "deb [signed-by=/etc/apt/keyrings/ra-yavuz.gpg] https://ra-yavuz.github.io/apt stable main" &gt; /etc/apt/sources.list.d/ra-yavuz.list &amp;&amp; apt update &amp;&amp; apt install -y meowtrics'
270+
systemctl --user enable --now meowtrics</code></pre>
271+
<p style="opacity: 0.85;">
272+
If you already added the <code>ra-yavuz</code> apt repo earlier, all you need is
273+
<code>sudo apt update &amp;&amp; sudo apt install meowtrics</code>. The
274+
<code>sudo apt update</code> step is required: without it apt will not see new
275+
packages or new versions.
276+
</p>
277+
<details>
278+
<summary>Step by step (manual repo setup)</summary>
279+
<pre><code># 1. Trust the signing key
280+
sudo install -m 0755 -d /etc/apt/keyrings
269281
curl -fsSL https://ra-yavuz.github.io/apt/pubkey.gpg \
270282
| sudo tee /etc/apt/keyrings/ra-yavuz.gpg > /dev/null
271283

284+
# 2. Add the apt source
272285
echo "deb [signed-by=/etc/apt/keyrings/ra-yavuz.gpg] https://ra-yavuz.github.io/apt stable main" \
273286
| sudo tee /etc/apt/sources.list.d/ra-yavuz.list
274287

288+
# 3. Refresh the package index, then install
275289
sudo apt update
276290
sudo apt install meowtrics
277291
systemctl --user enable --now meowtrics</code></pre>
292+
</details>
278293
</section>
279294

280295
<h2>Install single .deb from GitHub Releases</h2>

0 commit comments

Comments
 (0)