From d1e3b2d31dfe774acb778f5c2bf9b3a51b6df0e4 Mon Sep 17 00:00:00 2001 From: Hiltjo Posthuma Date: Sat, 18 Jan 2020 19:20:34 +0100 Subject: improve README a bit --- README | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'README') diff --git a/README b/README index 75dda9f..97f2c5e 100644 --- a/README +++ b/README @@ -68,13 +68,13 @@ HTML view with the menu as frames, copy style.css for a default style: To automatically update your feeds periodically and format them in a way you like you can make a wrapper script and add it as a cronjob. -Most protocols are supported because curl(1) is used by default, therefore -proxy settings from the environment (such as $http_proxy environment variable) +Most protocols are supported because curl(1) is used by default and also proxy +settings from the environment (such as the $http_proxy environment variable) are used. The sfeed(1) program itself is just a parser that parses XML data from stdin -and is therefore protocol-agnostic. It can be used with HTTP, HTTPs, Gopher, -SSH, etc. +and is therefore network protocol-agnostic. It can be used with HTTP, HTTPS, +Gopher, SSH, etc. See the section "Usage and examples" below and the man-pages for more information how to use sfeed(1) and the additional tools. @@ -90,11 +90,13 @@ Dependencies Optional dependencies --------------------- -- POSIX make(1) (for Makefile). +- POSIX make(1) for Makefile. - POSIX sh(1), used by sfeed_update(1) and sfeed_opml_export(1). +- POSIX utilities such as awk(1) and sort(1), + used by sfeed_update(1). - curl(1) binary: https://curl.haxx.se/ , - used by sfeed_update(1), can be replaced with any tool like wget(1), + used by sfeed_update(1), but can be replaced with any tool like wget(1), OpenBSD ftp(1) or hurl(1): https://git.codemadness.org/hurl/ - iconv(1) command-line utilities, used by sfeed_update(1). If the text in your RSS/Atom feeds are already UTF-8 @@ -111,7 +113,7 @@ OS tested - NetBSD - FreeBSD - Windows (cygwin gcc, mingw). -- HaikuOS +- HaikuOS (using libbsd). Architectures tested -- cgit v1.2.3