Overhaul Readme - Githubissues

qubist commented 2 years ago

Overhaul Readme for modern installation process.

qubist commented 2 years ago

⚠️ A few FIXMEs left in the file:

@dps can you help with these?

qubist commented 2 years ago

Suggested label: documentation

qubist commented 2 years ago

This PR, if accepted, will close #20

dps commented 2 years ago

How do I set up my development toolchain for this app? Install qtcreator and the reMarkable toolchain (which is no longer available from remarkable.engineering. I have an old copy I have dowloaded when it was available - do you know what the current method to access it is - I presume other toltec packages use it?). If you look at https://github.com/dps/remarkable-keywriter/blob/master/.circleci/config.yml you can see how I'm making this available for the continuous build on another package, but I don't want to be the official source.
How do I set up offline reading after installing from toltec? Download the file you want from https://dumps.wikimedia.org/other/kiwix/zim/wikipedia/ and copy it to your reMarkable with scp

dps commented 2 years ago

qubist commented 2 years ago

Thanks for these comments!

toolchain

I'll try to look into either including a link to a resource or compiling instructions myself.

Download the file you want from https://dumps.wikimedia.org/other/kiwix/zim/wikipedia/ and copy it to your reMarkable with scp

Sweet! Where in the filesystem of the reMarkable does remarkable-wikipedia look for it?

qubist commented 2 years ago

qubist commented 2 years ago

I think this is ready for review and merge, aside from four FIXMEs left in the file which need input, perhaps from @dps