Skip to content

Commit

Permalink
[docs] update remux docs [#94]
Browse files Browse the repository at this point in the history
  • Loading branch information
okay committed Feb 18, 2021
1 parent dbd3b37 commit a0c2daa
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions src/remux/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# reMux
# remux

reMux is an app switcher for remarkable. once its running, hold the middle
button down for several seconds until the reMux launcher appears
remux is an app switcher for the remarkable tablet. once its running, hold the
middle button down for several seconds until the remux launcher appears or
swipe up either side of the screen.

there are a couple ways to configure the list of apps that appear in reMux:
## Adding Apps

1. via code configuration - edit config.launcher.cpy
2. add a binary to the remux watch dir on the remarkable
3. using draft remarkable configuration files
usually, most people install [toltec](toltec-dev.org) and the apps in toltec
all use draft format and are installed into /opt/etc/draft.

but if you are writing a new app or trying out an unpackaged app, there are a
few ways to configure the list of apps that appear in remux:

1. via code configuration - edit config.launcher.cpy and recompile remux
2. add a binary to `/home/root/apps` on the remarkable and make sure it is `chmod +x`
3. using draft remarkable configuration files. they are installed into /opt/etc/draft

## Launching

Expand Down

0 comments on commit a0c2daa

Please sign in to comment.