Skip to content

Commit 9ab40d4

Browse files
author
Garrett Downs
authored
chore: update readme
1 parent 2fd929c commit 9ab40d4

1 file changed

Lines changed: 24 additions & 15 deletions

File tree

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,34 @@ A SoundCloud client for KaiOS.
88

99
This is very much a work in progress. Keep your eye on the changelog to see what's new!
1010

11-
Some things to know:
11+
### How to run on a KaiOS device
1212

13-
- Right Soft Key (RSK) while a list item is selected will open its context menu, where you can choose to play.
14-
- Left Soft Key (LSK) opens the app menu.
15-
- With the player open, Left will skip back 10 seconds, Right will skip forward 30 seconds, while Up and Down control volume.
13+
1. Connect your KaiOS device to your computer and make sure it appears in WebIDE (Waterfox Classic is recommended)
14+
2. Build the app with `npm run build`
15+
3. In WebIDE, load the `/public` folder as a packaged app
16+
4. On your computer, visit the [RainCloud website](https://app.vulpine.fm/) to sign into SoundCloud
17+
5. In the app, select 'Sign In via QR Code' and scan the code on your screen. \*You may have to exit and reopen the app to scan the code after giving permission
18+
6. When you scan the code, you're in!
19+
20+
### How to run in a browser locally
1621

17-
### How to use
22+
This is great for development and testing purposes.
1823

19-
1. Build the app and load through WebIDE (see instructions below).
20-
2. On your computer, visit the [RainCloud website](https://app.vulpine.fm/) to sign into SoundCloud.
21-
3. In the app, select 'Sign In via QR Code' and scan the code on your screen. \*You may have to exit and reopen the app to scan the code after giving permission.
22-
4. When you scan the code, you're in!
24+
1. [Create a KaiOS device profile in Chrome](https://github.com/garredow/foxcasts-lite#running-locally)
25+
2. Start the dev server with `npm run dev`
26+
3. Open http://localhost:3000
27+
4. In the app, select 'Sign In via Website'
2328

24-
### Development and testing
29+
All interaction is done using the keyboard.
2530

26-
`npm run dev` builds the app in watch mode and serves the site. Great for testing your app in a desktop browser.
31+
- Arrows keys to navigate lists and tabs
32+
- 1-9 are used as shortcuts in grids and lists
33+
- Backspace to navigate back a screen
34+
- Enter to perform the displayed action
35+
- Shift+LeftArrow and Shift+RightArrow to trigger left and right nav bar actions
2736

28-
### Deploying to a device
37+
### Navigation tips
2938

30-
1. Connect your device to your computer and make sure it appears in WebIDE.
31-
2. `npm run build`
32-
3. In WebIDE, load the `/public` folder as a packaged app.
39+
- Right Soft Key (RSK) while a list item is selected will open its context menu, where you can choose to play.
40+
- Left Soft Key (LSK) opens the app menu.
41+
- With the player open, Left will skip back 10 seconds, Right will skip forward 30 seconds, while Up and Down control volume.

0 commit comments

Comments
 (0)