Skip to content

Commit

Permalink
README: install dexOS
Browse files Browse the repository at this point in the history
Signed-off-by: Max Albrecht <[email protected]>
  • Loading branch information
eins78 committed Apr 22, 2024
1 parent ea84ce2 commit 733e88f
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,29 @@ packages:
* [example content](./packages/example-content/README.md)
* [branding](./packages/branding/README.md)

## getting started

Build a dex player by flashing the image to an SD card,
using the official [Raspberry Pi Imager](https://www.raspberrypi.org/software/).

Then boot the Raspberry Pi with the SD card.
It it worked, it will show a 2-second demo video loop.

### advanced

For customizing the player/operating system,
ssh access needs to be enabled.

This can be done using the "customization" feature of the Raspberry Pi Imager,
choosing "Enable SSH" in the "Advanced Options". It is recommended to use key-based authentication.
The user name in the image is `dex` should not be changed, the default password is also `dex` and should be changed if SSH login is enabled and password authentication is used.

Then, after booting the Raspberry Pi, ssh into it:

```sh
ssh dex@dexpi # or another hostname if you changed it in the customization
```

## development

### creating patches
Expand Down

0 comments on commit 733e88f

Please sign in to comment.