remarkable-wikipedia icon indicating copy to clipboard operation
remarkable-wikipedia copied to clipboard

Published 20 hours ago • verified publisher icon dps

Overhaul Readme

Open qubist opened this issue 2 years ago • 8 comments

Overhaul Readme for modern installation process.

Changes

  • Add up-to-date install section
  • Add sections (Background, Install, Usage, Gallery, Contributing, License)
  • Remove a lot of the text from @dps's blog post, but added link to it!
  • Resize images and added title text
  • Add swipe-to-scroll instructions for rM2

TODO:

  • [x] Update some screenshots (esp. wrt. keyboard)
  • [x] Add development instructions
  • [ ] Add offline reading setup instructions

qubist avatar Mar 13 '22 04:03 qubist

⚠️ A few FIXMEs left in the file:

  • How do I set up my development toolchain for this app?
  • How do I set up offline reading after installing from toltec?

@dps can you help with these?

qubist avatar Mar 13 '22 04:03 qubist

Suggested label: documentation

qubist avatar Mar 13 '22 04:03 qubist

This PR, if accepted, will close #20

qubist avatar Mar 13 '22 04:03 qubist

  • 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 avatar Mar 13 '22 05:03 dps

https://dumps.wikimedia.org/other/kiwix/zim/wikipedia/wikipedia_en_all_nopic_2022-01.zim is the "best" current full wikipedia (with no images) for folks installing from toltec

dps avatar Mar 13 '22 05:03 dps

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 avatar Mar 13 '22 20:03 qubist

This PR, if accepted, will close https://github.com/dps/remarkable-wikipedia/issues/24

qubist avatar Mar 13 '22 20:03 qubist

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

qubist avatar Mar 16 '22 04:03 qubist