From c2755dd288aa17bdb9edac10e8a807c86b95a6f7 Mon Sep 17 00:00:00 2001 From: Benton Edmondson Date: Mon, 6 Jun 2022 22:39:14 -0400 Subject: [PATCH] reordered readme to make more sense --- readme.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/readme.md b/readme.md index a1bbc7b..008414a 100644 --- a/readme.md +++ b/readme.md @@ -10,29 +10,16 @@ Convert ACSM files to PDF/EPUBs with one command on Linux ([and MacOS very soon] * Rename the binary and make it executable. * Run `knock /path/to/book.acsm` to perform the conversion. +## Dependencies + +There are no userspace runtime dependencies. + ## Verified Book Sources Knock should work on any ACSM file, but it has been specifically verified to work on ACSM files purchased [eBooks.com](https://www.ebooks.com/en-us/) and [Kobo](https://www.kobo.com/us/en), among others. Before buying your ebook, check if it is available for free on [Project Gutenberg](https://gutenberg.org/). -## The Name - -The name comes from the [D&D 5e spell](https://roll20.net/compendium/dnd5e/Knock#content) for freeing locked items: - -> ### Knock -> *2nd level transmutation*\ -> **Casting Time**: 1 action\ -> **Range**: 60 feet\ -> **Components**: V\ -> **Duration**: Instantaneous\ -> **Classes**: Bard, Sorcerer, Wizard\ -> Choose an object that you can see within range. The object can be a door, a box, a chest, a set of manacles, a padlock, or another object that contains a mundane or magical means that prevents access. A target that is held shut by a mundane lock or that is stuck or barred becomes unlocked, unstuck, or unbarred. If the object has multiple locks, only one of them is unlocked. If you choose a target that is held shut with arcane lock, that spell is suppressed for 10 minutes, during which time the target can be opened and shut normally. When you cast the spell, a loud knock, audible from as far away as 300 feet, emanates from the target object. - -## Dependencies - -There are no userspace runtime dependencies. - ## Contributing Install [Nix](https://github.com/NixOS/nix) if you don't have it. Enable [flakes](https://nixos.wiki/wiki/Flakes) if you haven't. @@ -57,6 +44,19 @@ nix run .#tests -- ./tests/workspace Test books can be found [here](https://www.adobe.com/solutions/ebook/digital-editions/sample-ebook-library.html). +## The Name + +The name comes from the [D&D 5e spell](https://roll20.net/compendium/dnd5e/Knock#content) for freeing locked items: + +> ### Knock +> *2nd level transmutation*\ +> **Casting Time**: 1 action\ +> **Range**: 60 feet\ +> **Components**: V\ +> **Duration**: Instantaneous\ +> **Classes**: Bard, Sorcerer, Wizard\ +> Choose an object that you can see within range. The object can be a door, a box, a chest, a set of manacles, a padlock, or another object that contains a mundane or magical means that prevents access. A target that is held shut by a mundane lock or that is stuck or barred becomes unlocked, unstuck, or unbarred. If the object has multiple locks, only one of them is unlocked. If you choose a target that is held shut with arcane lock, that spell is suppressed for 10 minutes, during which time the target can be opened and shut normally. When you cast the spell, a loud knock, audible from as far away as 300 feet, emanates from the target object. + ## License This software is licensed under GPLv3. The linked libraries have various licenses.