Browse Source

Add explanation of the "flipped" printer setting and update README

master
Daniel Schulte 4 years ago
parent
commit
992c39fd59
  1. 6
      README.md
  2. 3
      config.toml.example

6
README.md

@ -21,6 +21,8 @@ cp config.toml.example config.toml
$EDITOR config.toml
# Put the required information into config.toml
```
Besides the already mentioned API credentials the config.toml contains other (interesting) settings.
For each setting there is a short explanation on what the setting does and what the default value is if the setting is not defined.
# Printing Tweets
### Check your thermal printer
@ -34,13 +36,13 @@ $EDITOR config.toml
```bash
venv/bin/python3 printer.py --printer /path/to/printer
```
If you don't want to see retweets make sure to include the `-n` or`--no-retweets` option in the commandline above
If you don't want to see retweets make sure to include the `-n` or`--no-retweets` option in the command line above
### Printing a specific (or multiple) hashtags
```bash
venv/bin/python3 printer.py --printer /path/to/print "#hashtag1" "#hashtag2"
```
If you want to see retweets in this mode make sure to include the `-r` or `--retweets` option in the commandline above
If you want to see retweets in this mode make sure to include the `-r` or `--retweets` option in the command line above
# Developing/Testing
You can test this application without a thermal printer connected by simply omitting the `-p`/`--printer` argument when starting it. In that case you'll just get the output in your terminal.

3
config.toml.example

@ -7,4 +7,7 @@ token="PUT_YOUR_ACCESS_TOKEN_HERE"
secret="PUT_YOUR_ACCESS_SECRET_HERE"
[printer]
# The printout can be flipped upside down. In this mode the lines will be
# printed in reversed order. This is useful if the printer is mounted on a wall.
# Default Value: false
flipped=false
Loading…
Cancel
Save