Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul Readme #26

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Overhaul Readme #26

wants to merge 11 commits into from

Conversation

qubist
Copy link

@qubist qubist commented Mar 13, 2022

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:

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

* 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!
* Resized images and added title text
* Added swiping instructions for rM2

⚠️ A few `FIXME`s 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?
@qubist
Copy link
Author

qubist commented Mar 13, 2022

⚠️ 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
Copy link
Author

qubist commented Mar 13, 2022

Suggested label: documentation

@qubist
Copy link
Author

qubist commented Mar 13, 2022

This PR, if accepted, will close #20

@dps dps marked this pull request as ready for review March 13, 2022 05:41
@dps
Copy link
Owner

dps commented Mar 13, 2022

  • 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
Copy link
Owner

dps commented Mar 13, 2022

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

@qubist
Copy link
Author

qubist commented Mar 13, 2022

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
Copy link
Author

qubist commented Mar 13, 2022

This PR, if accepted, will close #24

@qubist
Copy link
Author

qubist commented Mar 16, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants