commit 3a97a069bdfcf64cacc3800026d548a8f1154a89 from: witcher date: Sun Dec 18 09:31:27 2022 UTC Extend README.md with new man page Also fix `sqlx-cli` mistakenly being referred to as `cargo-sqlx`. commit - cd3dd5735784dfcb0fba2937cdd30b27a298c0be commit + 3a97a069bdfcf64cacc3800026d548a8f1154a89 blob - 9ff53e6935f73600f7c599f1fd775218602e4b0c blob + 3e3aec3454f536382dd2273b39ac4f1e16ca7f53 --- README.md +++ README.md @@ -17,7 +17,7 @@ Install the dependencies: - Rust - sqlite -- [cargo-sqlx](https://github.com/launchbadge/sqlx/tree/main/sqlx-cli#install) +- [sqlx-ci](https://github.com/launchbadge/sqlx/tree/main/sqlx-cli#install) (optional, only for development) - scdoc (optional) @@ -35,10 +35,11 @@ Then compile `rss-email`: cargo build ``` -To build the man page, use `scdoc`: +To build the man pages, use `scdoc`: ``` scdoc < docs/rss-email.1.scd > docs/rss-email.1 +scdoc < docs/rss-email.5.scd > docs/rss-email.5 ``` ## Usage @@ -51,7 +52,9 @@ The database used with `rss-email` is generated automa 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`. +generating it with `scdoc` with `man -l docs/rss-email.1`. +A man page for the configuration exists, too, which you can view after building +with `scdoc`: `man -l doc/rss-email.5`. ## Resources