From e8652cc81368dea57bf4f5b0c9ba38d5d76017f3 Mon Sep 17 00:00:00 2001
From: "Dustin C. Hatch" <dustin@hatch.name>
Date: Sun, 12 Dec 2021 21:09:57 -0600
Subject: [PATCH] Add README

---
 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eed5136
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# Rupert
+
+*Rupert the Ripper* is a command-line tool for ripping audio CDs.
+
+
+## Prerequisites
+
+
+You must have direct read/write access to your CD-ROM block device.  On Fedora,
+this can be achieved by adding your user to the *disk* group:
+
+```
+sudo gpasswd -a ${USER} disk
+```
+
+You will need to log out and back in for this change to take effect.
+
+
+## Installation
+
+### System Dependencies
+
+#### Fedora
+
+```
+sudo dnf install \
+    cdparanoia \
+    flac \
+    libdiscid-devel \
+    poetry \
+    python3-devel \
+    --
+```
+
+### Install *Rupert*
+
+
+There are no published releases of *Rupert* yet, so you will need to install it
+from a `git` checkout:
+
+```
+git clone https://git.pyrocufflink.blue/dustin/rupert.git
+cd rupert
+poetry install -E udev
+```
+
+The *udev* extra enables support for identifying CD drives using udev.  This
+allows Rupert to find your drive and select the correct offset automatically.
+
+
+## Usage
+
+The `ripper` command is the main entry point for *Rupert*.  If you installed
+using `poetry`, you can run it with `poetry run ripper`.
+
+
+```
+poetry run ripper --help
+```