BentonEdmondson/knock
1
0
Fork 0
Code Issues Pull requests Releases Activity Actions
https://web.archive.org/web/20221116202055/http://github.com/BentonEdmondson/knock
58 commits 1 branch 0 tags 706 KiB
Nix 56.9%
C++ 29.6%
Python 13.5%
Find a file
Benton Edmondson 26fe53dfd8 changed demo.svg to png for better consistency
2022-06-21 23:42:42 -04:00
.github/workflows github actions test added, but disabled until auto-releases are added 2022-06-05 21:25:07 -04:00
assets changed demo.svg to png for better consistency 2022-06-21 23:42:42 -04:00
src delete acsm file after use because it can't be reused--only causes confusion 2022-06-09 00:01:16 -04:00
tests tests run twice to verify redownloaded acsm can still be converted 2022-06-07 23:48:34 -04:00
.gitignore switched from python to cpp 2022-06-04 23:14:43 -04:00
flake.lock removed deprecated syntax from flake 2022-06-06 22:32:55 -04:00
flake.nix formatter is much cleaner 2022-06-07 23:50:34 -04:00
license lowercased file names, tweaked a bit of output 2021-09-12 19:41:59 -05:00
readme.md changed demo.svg to png for better consistency 2022-06-21 23:42:42 -04:00

readme.md

Knock

Convert ACSM files to PDF/EPUBs with one command on Linux (and MacOS very soon).

Demonstration of CLI usage

This software does not utilize Adobe Digital Editions nor Wine. It is completely free and open-source software written natively for Linux.

Installation

  1. Run uname -ms and, based on the output, download the latest corresponding release.
  2. Open a terminal and cd into the directory that knock is in (e.g. cd ~/Downloads).
  3. Run mv knock-version-arch-os knock to rename the binary to knock.
  4. Run chmod +x knock to make it executable.
  5. Run ./knock ./path/to/book.acsm to perform the conversion.
  6. Run mv knock ~/.local/bin to allow it to be run from anywhere (might not work on some distributions).

Nix and NixOS (with flakes enabled)

If you are on a system with Nix, you can use the following.

nix profile install github:BentonEdmondson/knock

If you are on NixOS, you can add the flake to your system config.

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 and Kobo, among others.

Before buying your ebook, check if it is available for free on Project Gutenberg.

Contributing

Install Nix if you don't have it. Enable flakes if you haven't.

Building

nix build

Updating

nix flake update

Testing

nix run .#tests -- ./tests/workspace

Test books can be found here.

Formatting

nix run .#formatter

The Name

The name comes from the D&D 5e spell 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.