added demo image and more detailed instructions to readme

This commit is contained in:
Benton Edmondson 2022-06-21 21:52:06 -04:00
parent 4081827049
commit 0874fd8ace
3 changed files with 63 additions and 3 deletions

28
assets/config.json Normal file
View file

@ -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
}

17
assets/demo.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 623 KiB

View file

@ -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)). 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.* *This software does not utilize Adobe Digital Editions nor Wine. It is completely free and open-source software written natively for Linux.*
## Installation ## 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). 1. Run `uname -ms` and, based on the output, download the latest corresponding [release](https://github.com/BentonEdmondson/knock/releases).
* Rename the binary and make it executable. 1. Open a terminal and `cd` into the directory that knock is in (e.g. `cd ~/Downloads`).
* Run `knock /path/to/book.acsm` to perform the conversion. 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 ## Dependencies