summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c171023
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# rtv4d-dl: program za prenašanje videoposnetkov iz arhiva TV SLO
+
+## legalne stvari
+z uporabo programa se strinjate z naslednjimi stavki:
+* avtorja ne boste tožili in se strinjate, da je program povsem legalen.
+* program uporabljate na lastno odgovornost.
+* če ni kje drugje avtor napisal drugače ali če to ni zakonsko drugače:
+ - ne smete distribuirati programa in izdelovali kopij.
+ - smete ga uporabljati samo za zasebno nekomercialno uporabo.
+
+## funkcije
+* prenašanje videoposnetkov iz arhiva kot odklenjene videodatoteke
+
+## možnosti uporabe programa
+* prenos oddaje: `rtv4d-dl oddaja <URL/ID oddaje> [izhodna datoteka]`
+ - primer: `rtv4d-dl oddaja 4d.rtvslo.si/arhiv/vreme/89614963`
+ - primer: `rtv4d-dl oddaja 89614963 89614963.mp4`
+* prenos metapodatkov oddaje: `rtv4d-dl meta-oddaja <URL> [datoteka]`
+ - primer: `rtv4d-dl meta-oddaja 89614963 89614963.txt`
+ - opomba: nekateri metapodatki veljajo omejeno časa (video URL)
+* prenos sličice oddaje: `rtv4d-dl slicica-oddaja <URL> [datoteka]`
+ - primer: `rtv4d-dl slicica-oddaja 89614963 89614963.jpg`
+
+# dodatne informacije:
+* pisanje v STDOUT: kot pot datoteke napišite `/dev/stdout` (samo POSIX)
+* program se poveže na 4D strežnik 4d.rtvslo.si, spremenite izv. kodo za drugega
+
+# trenutna izdaja programa:
+* program je bil nazadnje ročno testiran 9. decembra 2020 in takrat je DELOVAL.
+* različica: 0.0.0
+
+# o
+* program je spisan 100% v C programskem jeziku
+* ne potrebuje nobenih knižnjic, razen seveda `stdio.h` in `stdlib.h` (še)
+* navodila za grajenje (na Debian):
+ - `make`
+
+# še za narediti
+* dodati podporo za varno povezavo, sedaj gre vsa komunikacija z RTV4D kot HTTP.