summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsiddharth <s@ricketyspace.net>2021-11-27 13:28:05 -0500
committersiddharth <s@ricketyspace.net>2021-11-27 13:28:05 -0500
commitbf7695b8d3abdf33c285febc22c582c7b12b4205 (patch)
treeb77c201a87cec9ca772984f5da61508b6b2334c6 /README.md
initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad6e55d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# fern
+
+RSS/Atom media feed downloader.
+
+Depends on [youtube-dl][ydl] for downloading media.
+
+[ydl]: https://youtube-dl.org
+
+## building
+
+requires `make` and `go >= 1.15`
+
+to build it, just do:
+
+```
+make
+```