Tree


.build.ymlcommits | blame
.gitignorecommits | blame
Cargo.lockcommits | blame
Cargo.tomlcommits | blame
LICENSEcommits | blame
README.mdcommits | blame
config.example.tomlcommits | blame
diesel.tomlcommits | blame
docs/
migrations/
src/

README.md

# rss-email

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

## Compiling

Install the dependencies:

- Rust
- scdoc (optional)

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`.

Stripped binaries are available on
[tags](https://git.sr.ht/~witcher/rss-email/refs) or
[builds](https://builds.sr.ht/~witcher/rss-email/commits/main/.build.yml) from
up to 90 days ago.

## Resources

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

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).