README.md (2102B)
1 # txtv - A client for reading swedish text tv in the terminal 2 3 Text-tv is great! plaintext and to-the-point news with no filler. 4 Now you can read it without touching your mouse or your tv-remote :) 5 6 ## Installation 7 8 If you have Python 3.6 or later with pip installed, just run 9 10 pip3 install --user txtv 11 12 Currently wont work natively on the Windows command line because of [readline](https://docs.python.org/3/library/readline.html); but you can use it with [Ubuntu for Windows](https://tutorials.ubuntu.com/tutorial/tutorial-ubuntu-on-windows#0). 13 14 ## Usage 15 16 Running with no arguments will enter interactive mode. 17 18 txtv 19 20 From there you can run any of these commands: 21 22 help | h | ? -- show this help text. 23 quit | q | exit -- quit the program (duh) 24 list | ls | l -- list all articles 25 next | n | > -- show next available page. 26 previous | prev | p | < -- show previous available page. 27 <PAGE NUMBER> -- show the page at the specified number 28 29 You can also give any of these commands as an argument on the normal command line to run un-interactively. Except for `quit`, `next`, and `previous`, because that would make no sense. 30 31 txtv 100 # show page 100 32 33 txtv ls # list all news articles 34 35 ## Configuration 36 37 txtv.py will automatically generate a config file at `~/.config/txtv/txtv.cfg` with default values. It uses format of [configparser](https://docs.python.org/3/library/configparser.html#supported-ini-file-structure). 38 39 ### alias 40 41 under the alias category you can specify any number of aliases for txtv commands. These will work both in interactive mode and as subcommands when calling txtv from your shell. 42 43 example: 44 45 [alias] 46 all=list 47 48 will let you list all articles from shell with 49 50 txtv all 51 52 or by typing `all` in interactive mode. 53 54 ### general 55 56 So far there is only one option here, named `prompt`. It is just the prompt string used in interactive mode. 57 58 example: 59 60 [general] 61 prompt = kommandorörelse> 62 63 ## Links 64 65 Here is the trello for the development of txtv: https://trello.com/b/aBI0DpN3/txtv 66 67 Here is where it's scraping data from: https://www.svt.se/svttext/web/pages/100.html