Skip to content

Commit

Permalink
Mention build artifacts on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
phildenhoff authored Jan 16, 2024
1 parent 46d497e commit a45c76c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Manage your ebook library with Citadel. Backwards compatible with Calibre.

https://github.com/every-day-things/citadel/assets/17505728/84a0c9dd-f14e-411a-8947-1d599f3ad85a

**Citadel is very early software, and as such is full of bugs and lacking features.**

## Project goals

Expand All @@ -17,6 +18,16 @@ https://github.com/every-day-things/citadel/assets/17505728/84a0c9dd-f14e-411a-8
- **...or editor**: If you're editing ebook _content_ (not metadata like titles), Citadel will not be a replacement for you.
- **100% feature parity**: Primarily around Plugins, but there are some advanced features of Calibre we'll likely never build.

## Downloading

> [!WARNING]
> Citadel is _very_ early in development. It will crash. A lot. It may corrupt your ebook library.
>
> **Back up your Calibre library regularly if you use Citadel on it.**
Citadel builds are available from [GitHub actions](https://github.com/every-day-things/citadel/actions/runs/7536243753).
There is no guarantee these builds work.

## Developing

As a prerequisite, you'll need to install [Bun](https://bun.sh) and [Rust](https://www.rust-lang.org/tools/install).
Expand Down

0 comments on commit a45c76c

Please sign in to comment.