Tree


.build.ymlcommits | blame
.gitignorecommits | blame
Cargo.lockcommits | blame
Cargo.tomlcommits | blame
LICENSEcommits | blame
README.mdcommits | blame
config.example.tomlcommits | blame
docs/
migrations/
sqlx-data.jsoncommits | blame
src/

README.md

# rss-email

Fetch new RSS feed items and send them via E-Mail.

## Compiling

Install the dependencies:

- Rust
- [cargo-sqlx](https://github.com/launchbadge/sqlx/tree/main/sqlx-cli#install)
- scdoc (optional)

First specify the `DATABASE_URL` environment variable and set up the database
with `cargo-sqlx`:

```
export DATABASE_URL='sqlite://./dev.db'
cargo sqlx database setup
```

Then compile `rss-email`:

```
cargo build
```

To build the man page, use `scdoc`:

```
scdoc < docs/rss-email.1.scd > docs/rss-email.1
```

## Usage

- Copy the `config.example.toml` to `~/rss-email/config.toml` and adjust the
values
- Create a `urls` file at `~/rss-email/urls` with one RSS url per line

The database used with `rss-email` is generated automatically if it doesn't exist
yet

See the man page or `-h` for more info. You can view the man page after
generating it with `scdoc` with `man -l docs/rss-email.1`.

## Resources

Send patches and questions to
[~witcher/rss-email-devel@lists.sr.ht](https://lists.sr.ht/~witcher/rss-email-devel).

Instructions for preparing a patch are available at
[git-send-email.io](https://git-send-email.io/).

Bugs and todo can be found at
[~witcher/rss-email](https://todo.sr.ht/~witcher/rss-email).

# Contributing

## Making changes on the database

When making changes on the database, make sure that:

- a migration is created in the `migrations` folder with `cargo sqlx migrate add
  -r $MIGRATION_DESCRIPTION`
- `sqlx-data.json` is up to date by issuing `cargo sqlx prepare`