Skip to content

Commit

Permalink
Update readme with latest dHONKumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
j6k4m8 committed Nov 2, 2020
1 parent 2e900e7 commit c7981fb
Showing 1 changed file with 17 additions and 48 deletions.
65 changes: 17 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

goosepaper is a utility that delivers a daily newspaper to your remarkable tablet. that's cute!

you can include RSS feeds, Twitter feeds, news articles, wikipedia articles-of-the-day, weather, and more. I read it when I wake up so that I can feel anxious without having to get my phone out.
you can include RSS feeds, Twitter feeds, news articles, wikipedia articles-of-the-day, weather, and more. I read it when I wake up so that I can feel anxious without having to get my phone.

## installation

Expand Down Expand Up @@ -40,72 +40,41 @@ sudo apt-get install build-essential python3-dev python3-pip python3-setuptools
pip3 install -r ./requirements.txt
```

Check out `main.py` for an example usage!
Check out [this example PDF](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/docs/Example-Nov-1-2020.pdf), generated on Nov 1 2020 using `main.py`.
## get started


## existing story providers (want to write your own?)

* [Wikipedia Top News / Current Events](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L112)
* [Tweets](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L154) (Note: Currently borked, see [Issue #5](https://github.com/j6k4m8/goosepaper/issues/5))
* [Weather](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L258). These stories appear in the "ear" of the front page, just like a regular ol' newspaper
* [RSS Feeds](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L283)
* [Reddit Subreddits](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L307)

## usage

execute easily using [frof](https://github.com/j6k4m8/frof):

```shell
frof remarkable.frof
```

You can add this to a crontab to run daily in the morning.

### slightly more annoying, without frof:
You can customize your goosepaper by editing `main.py`. (Better customization tools coming soon!)

```shell
mkdir -p temp
python3 main.py > temp/test.html
wkhtmltopdf temp/test.html temp/test.pdf
open temp/test.pdf
python3 ./main.py
```

### p2r
Check out [this example PDF](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/docs/Example-Nov-1-2020.pdf), generated on Nov 1 2020.

You'll need a [`p2r` of some variety](https://github.com/GjjvdBurg/paper2remarkable) installed; this tool syncs documents to your tablet. (You can also use this without p2r, and sync the PDF yourself.) I'd recommend cloning the p2r repo and building with docker:

```shell
git clone https://github.com/GjjvdBurg/paper2remarkable
cd paper2remarkable
docker build -t p2r .
```

## yes but pardon me — i haven't a remarkable tablet

Do you have another kind of tablet? You may generate a print-ready PDF which you can use on another kind of robot as well!
## existing story providers (want to write your own?)

```shell
frof frofs/pdf-only.frof
```
- [Wikipedia Top News / Current Events](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L112)
- [Tweets](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L154) (Note: Currently borked, see [Issue #5](https://github.com/j6k4m8/goosepaper/issues/5))
- [Weather](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L258). These stories appear in the "ear" of the front page, just like a regular ol' newspaper
- [RSS Feeds](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L283)
- [Reddit Subreddits](https://github.com/j6k4m8/goosepaper/blob/71ee16e91840560fe40234493a02a283cb84083f/goosepaper/__init__.py#L307)

## thank you, but i prefer not to install `frof`!
# More Questions, Infrequently Asked

that is ok! you can still use this like a Python library, and move the resulting HTML or PDF onto your device of choice.
### yes but pardon me — i haven't a remarkable tablet

# More Questions, Infrequently Asked
Do you have another kind of tablet? You may generate a print-ready PDF which you can use on another kind of robot as well! Just remove the last line of `main.py`.

## very nice! may i have it in comic sans?
### very nice! may i have it in comic sans?

yes! you may do anything that you find to be fun and welcoming :)

Check out the `styles.Styles` enum in the goosepaper library. You will find there what you seek.

## do all dogs' names start with the letter "B"?
### do all dogs' names start with the letter "B"?

I do not think so, but it is a good question!

## may i use this to browse twitter?
### may i use this to browse twitter?

yes you may! you can add a list of usernames to the feed generator and it will make a print-ready version of twitter. this is helpful for when you are on twitter on your laptop but wish you had Other Twitter as well, in print form.

Expand Down

0 comments on commit c7981fb

Please sign in to comment.