Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iambenzo committed Nov 22, 2024
1 parent 077e53c commit 7bdb7c2
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/bundle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ jobs:
with:
draft: true
generate_release_notes: true
tag_name: ktr v${{ env.VERSION }}
tag_name: v${{ env.VERSION }}
files: |
artifacts/PKGBUILD
artifacts/*_aarch64.dmg
Expand Down
72 changes: 0 additions & 72 deletions .github/workflows/release.yaml

This file was deleted.

29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# KTR
<div align="center">
<img src="./gui/assets/logo.png" alt="Logo" style="width: 30%">
</div>

# Kindle to References (KTR)

The idea of this utility is to convert the highlights I've made in my Kindle to a format that I can use in my Zettelkasten (Obsidian).

## Installation

There are no binaries currently provided via a github release, the only way to install for now is via `cargo`:
The cleanest way to install KTR is via `cargo`:

```sh
cargo install --git https://github.com/iambenzo/ktr.git --branch main ktr # for cli
Expand All @@ -13,7 +17,26 @@ cargo install --git https://github.com/iambenzo/ktr.git --branch main ktr_gui #

This will install the `ktr` CLI tool and a `ktr_gui` GUI tool.

> If there's demand, I'll create a release action.
There are [Releases](https://github.com/iambenzo/ktr/releases/latest) available. However, none of the applications are signed, which may mean you have to do some "unblocking" before you can run the apps on your machine. I haven't found this to be an issue on Linux.

### Unblocking on Mac

Simply remove the quarantine flag that is put on the executable/dmg file:

```sh
xattr -d com.apple.quarantine <dmg_or_cli>
```

You may also need to:

```sh
chmod +x <dmg_or_cli>
```

### Unblocking on Windows

Right-click on the `.exe` file and select "Properties". Under the "General" tab, you'll see a checkbox near the bottom of the window labelled "Unblock" - click it. Once you done that, click "Apply" and then "Okay".


## Usage

Expand Down

0 comments on commit 7bdb7c2

Please sign in to comment.