README: add preface text, list dependencies - tscrape - twitter scraper | |
git clone git://git.codemadness.org/tscrape | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 5e6e62cf3522747a7c4573736d774503ff139a12 | |
parent 2f683439be0f889e05e42965926d44a7332f042d | |
Author: Hiltjo Posthuma <[email protected]> | |
Date: Sun, 12 May 2019 19:19:37 +0200 | |
README: add preface text, list dependencies | |
Diffstat: | |
M README | 35 +++++++++++++++++++++++++++--… | |
1 file changed, 31 insertions(+), 4 deletions(-) | |
--- | |
diff --git a/README b/README | |
@@ -1,9 +1,17 @@ | |
-tscrape - twitter (sc)raper | |
-=========================== | |
+tscrape | |
+------- | |
+Twitter feed HTML scraper. | |
+ | |
+It scrapes HTML from stdin and outputs it to a TAB-separated format that can be | |
+easier parsed with various (UNIX) tools. There are formatting programs included | |
+to convert this TAB-separated format to various other formats. There are also | |
+some programs and scripts included to import and export OPML and to update, | |
+sort, filter and merge feed items. | |
-Install | |
-------- | |
+ | |
+Build and install | |
+----------------- | |
$ make | |
# make install | |
@@ -41,6 +49,25 @@ authenticating or using their API. With this program you can… | |
any way you like relatively anonymously. | |
+Dependencies | |
+------------ | |
+ | |
+- C compiler (C99). | |
+- libc (recommended: C99 and POSIX >= 200809). | |
+ | |
+ | |
+Optional dependencies | |
+--------------------- | |
+ | |
+- POSIX make(1) (for Makefile). | |
+- POSIX sh(1), | |
+ used by tscrape_update(1). | |
+- curl(1) binary: https://curl.haxx.se/ , | |
+ used by tscrape_update(1), can be replaced with any tool like wget(1), | |
+ OpenBSD ftp(1) or hurl(1): https://git.codemadness.org/hurl/ | |
+- mandoc for documentation: https://mdocml.bsd.lv/ | |
+ | |
+ | |
License | |
------- | |