commit 690f1709288face8957679667fa28849d6a18adf
from: witcher <witcher@wiredspace.de>
date: Sun Nov 20 16:12:57 2022 UTC

Elaborate on sqlx for compiling and contributing

commit - 84367b4779497a04a427734bef0998800dba601b
commit + 690f1709288face8957679667fa28849d6a18adf
blob - 77d76947d0c532dde31c15d8484db49c53818dc2
blob + afe10f0d5a9d8c67181a665543355b77e74f78c5
--- README.md
+++ README.md
@@ -7,8 +7,17 @@ Fetch new RSS feed items and send them via E-Mail.
 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='./dev.db'
+cargo sqlx database setup
+```
+
 Then compile `rss-email`:
 
 ```
@@ -33,11 +42,6 @@ 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
@@ -48,3 +52,13 @@ Instructions for preparing a patch are available at
 
 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`