Browse Source

Update README with screenshot.

pull/1/head
Dejvino 3 years ago
parent
commit
6cb42a8850
2 changed files with 10 additions and 8 deletions
  1. +10
    -8
      README.md
  2. BIN
      screenshots.png

+ 10
- 8
README.md View File

@@ -3,7 +3,7 @@ Sway UI configured for PINE64 PinePhone (Proof Of Concept)

You can find ready-made config files and installation instructions on how to set up Sway on postmarketOS and use it with a PinePhone.

**TODO: insert a photo**
![Screenshots](./screenshots.png)

## Install
Start with a [postmarketOS](https://wiki.postmarketos.org/wiki/PINE64_PinePhone_(pine64-pinephone)) for PinePhone image with `postmarketos-ui-sway` installed. Either use the pre-built demo image or build a custom one with `pmbootstrap`.
@@ -13,13 +13,13 @@ Flash the system onto the phone (either to an SD card or directly to the eMMC wi
Open a terminal on the phone (either through SSH, the serial connection or directly on the screen) and run this:
```
# components
$ sudo apk add waybar bemenu networkmanager
$ sudo apk add waybar bemenu swaylock swayidle networkmanager htop pavucontrol

# build tools
$ sudo apk add git make waybar bemenu networkmanager
$ sudo apk add git make meson ninja

# installation
$ git clone https://github.com/Dejvino/pinephone-sway-poc
$ git clone --recurse-submodules https://github.com/Dejvino/pinephone-sway-poc
$ cd pinephone-sway-poc
$ make install_user
$ sudo make install_system
@@ -35,14 +35,16 @@ That's it. You should now have everything in place. Reboot to use the new settin
## Components
* postmarketOS - base Linux distribution (though any other would work as well)
* sway (pmos package) - tiling Wayland compositor
* squeekboard (pmos package) - on-screen keyboard for Wayland
* * [terminal.yaml](https://source.puri.sm/btantau/squeekboard/blob/btantau-master-patch-76686/data/keyboards/terminal.yaml) - keyboard layout based on this improved version
* * swayidle, swaylock - utils for sway
* bemenu (pmos package) - app launcher
* waybar (pmos package) - Wayland status bar
* * [carlosdss22/dotfiles](https://github.com/carlosdss22/dotfiles/tree/master/waybar) - styles used
* htop (pmos package) - Processes monitoring
* squeekboard (pmos package) - on-screen keyboard for Wayland
* * [terminal.yaml](https://source.puri.sm/btantau/squeekboard/blob/btantau-master-patch-76686/data/keyboards/terminal.yaml) - keyboard layout based on this improved version
* [pinephone-toolkit](https://github.com/Dejvino/pinephone-toolkit) - various utilities for the PinePhone
* [sxmo-lisgd](https://git.sr.ht/~mil/lisgd) - gesture detection daemon
* [sxmo-utils](https://git.sr.ht/~mil/sxmo-utils) - various utilities for the PinePhone
* htop (pmos package) - Processes monitoring
* pavucontrol (pmos package) - PulseAudio control panel

(*pmos package* = available as a package directly from the postmarketOS repository)


BIN
screenshots.png View File

Before After
Width: 1400  |  Height: 907  |  Size: 2.6 MiB

Loading…
Cancel
Save