Git Product home page Git Product logo

appmarkable's Introduction

appMarkable

rm1 rm2 opkg

This is a fairly dumb ui, meant to be a placeholder for apps who want to be started from draft, oxide and remux.

Example for rmWacomToMouse/rmServeWacomInput:

Usage

USAGE:
    appmarkable [OPTIONS] <command> [args]...

ARGS:
    <command>    Full path to the executable
    <args>...    Arguments for the executable

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --custom-image <custom-image>    Display a custom full image instead of name and icon.
    -i, --icon <icon>                    Path for icon to display
        --icon-size <icon-size>          Size of icon to display (squared) [default: 500]
    -n, --name <name>                    App name to display

Quick start

If you decided to make your app accessible as a package (ipkg) and wan't to have a place in above mentioned launchers, you can specify the same name and icon as used in the draft file (full path though).

The following draft file

name=myAwesomeApp
desc=This is my really cool app
call=/opt/bin/myawesomeapp
term=:
imgFile=myawesomeapp

would turn into

name=myAwesomeApp
desc=This is my really cool app
call=/opt/bin/myawesomeapp-gui
term=:
imgFile=myawesomeapp

where /opt/bin/myawesomeapp-gui is a shell script containing the command to launch the app

#!/bin/bash
/opt/bin/appmarkable /opt/bin/myawesomeapp -n myAwesomeApp -i /opt/etc/draft/icons/myawesomeapp.png

(the extra script is because not all launchers support cli options in the call entry for draft)

Also don't forget to make you package depend on appmarkable to make sure it is installed.

Now you have some UI that just signals that your app is running. The user can quit it by pressing the power and right button together (which sends a SIGINT just like CTRL+C would).

Step it up a notch

If you want more control over the design, you can also just provide a full image to display instead with --custom-image. Though please tell the user how to quit the app, is it isn't done in this mode.

reMarkable 2 support

As of now, the new framebuffer is not yet figured out. As soon as that happens and libremarkable gets updated, I can fix this sw to work on the rM 2.

appmarkable's People

Contributors

eeems avatar linuscde avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

domib97 eeems

appmarkable's Issues

Add Oxide 2.0+ support

Same as LinusCDE/retris#2 .

The readme should be adjusted to refrain from creating a call= that contains arguments and prefer a wrapper script since Oxide 2.0+ will stop supporting arguments in call= in it's oxide file.

reMarkable 2 support

I tried running appmarkable with the rm2fb client library and it’s working great. The only thing that prevents this from working on reMarkable 2 (if I’m not mistaken) is that there’s no “Right” button, so users can’t quit the app. Could it be possible to change the shortcut to something that works on both versions of the device (press only the power button, a tap gesture, …)?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.