From 0874fd8acebd53e6fd90c078f417ca753a273f57 Mon Sep 17 00:00:00 2001 From: Benton Edmondson Date: Tue, 21 Jun 2022 21:52:06 -0400 Subject: [PATCH] added demo image and more detailed instructions to readme --- assets/config.json | 28 ++++++++++++++++++++++++++++ assets/demo.svg | 17 +++++++++++++++++ readme.md | 21 ++++++++++++++++++--- 3 files changed, 63 insertions(+), 3 deletions(-) create mode 100644 assets/config.json create mode 100644 assets/demo.svg diff --git a/assets/config.json b/assets/config.json new file mode 100644 index 0000000..b5bd3b2 --- /dev/null +++ b/assets/config.json @@ -0,0 +1,28 @@ +{ + "paddingVertical": "45px", + "paddingHorizontal": "45px", + "backgroundImage": null, + "backgroundImageSelection": null, + "backgroundMode": "color", + "backgroundColor": "rgba(31,129,109,1)", + "dropShadow": true, + "dropShadowOffsetY": "12px", + "dropShadowBlurRadius": "22px", + "theme": "nord", + "windowTheme": "none", + "language": "text", + "fontFamily": "Hack", + "fontSize": "14px", + "lineHeight": "150%", + "windowControls": true, + "widthAdjustment": true, + "lineNumbers": false, + "firstLineNumber": 1, + "exportSize": "4x", + "watermark": false, + "squaredImage": false, + "hiddenCharacters": false, + "name": "", + "width": 680, + "highlights": null +} \ No newline at end of file diff --git a/assets/demo.svg b/assets/demo.svg new file mode 100644 index 0000000..2160685 --- /dev/null +++ b/assets/demo.svg @@ -0,0 +1,17 @@ +
 \ No newline at end of file diff --git a/readme.md b/readme.md index 5a4ae49..8f898ee 100644 --- a/readme.md +++ b/readme.md @@ -2,13 +2,28 @@ Convert ACSM files to PDF/EPUBs with one command on Linux ([and MacOS very soon](https://github.com/BentonEdmondson/knock/issues/58)). +![Demonstration of CLI usage](./assets/demo.svg) + *This software does not utilize Adobe Digital Editions nor Wine. It is completely free and open-source software written natively for Linux.* ## Installation -* Download the latest [release](https://github.com/BentonEdmondson/knock/releases). Make sure it is the correct version for your architecture (run `uname -m` to check). -* Rename the binary and make it executable. -* Run `knock /path/to/book.acsm` to perform the conversion. +1. Run `uname -ms` and, based on the output, download the latest corresponding [release](https://github.com/BentonEdmondson/knock/releases). +1. Open a terminal and `cd` into the directory that knock is in (e.g. `cd ~/Downloads`). +1. Run `mv knock-version-arch-os knock` to rename the binary to `knock`. +1. Run `chmod +x knock` to make it executable. +1. Run `./knock ./path/to/book.acsm` to perform the conversion. +1. Run `mv knock ~/.local/bin` to allow it to be run from anywhere (might not work on some distributions). + +### Nix and NixOS (with [flakes](https://nixos.wiki/wiki/Flakes) enabled) + +If you are on a system with [Nix](https://github.com/NixOS/nix), you can use the following. + +``` +nix profile install github:BentonEdmondson/knock +``` + +If you are on [NixOS](https://github.com/NixOS/nixpkgs), you can add the flake to your system config. ## Dependencies