Update README
This commit is contained in:
parent
902e3afe4f
commit
8c3e6479e7
64
README.md
64
README.md
|
@ -1,10 +1,60 @@
|
|||
# Squeak-Phone: Running Squeak Smalltalk as the UI for a PostmarketOS-based Cellphone
|
||||
|
||||
License: MIT.
|
||||
# SqueakPhone: Running Squeak Smalltalk as the UI for a PostmarketOS-based Cellphone
|
||||
|
||||
License: MIT.
|
||||
Copyright ©2020–2022 Tony Garnock-Jones.
|
||||
|
||||
## How to use pmbootstrap
|
||||
SqueakPhone comes in two pieces: this is the `git`-based portion, and **there's another part
|
||||
that lives in [SqueakSource](https://squeaksource.com/SqueakPhone.html)**.
|
||||
|
||||
The relevant packages to load into your Squeak image are:
|
||||
|
||||
```smalltalk
|
||||
Installer squeaksource project: 'Preserves'; install: 'Preserves'.
|
||||
Installer squeaksource project: 'TouchScrolling'; install: 'TouchScrolling'.
|
||||
Installer squeaksource project: 'TiledMaps'; install: 'TiledMaps'.
|
||||
Installer squeaksource
|
||||
project: 'SyndicatedActors';
|
||||
install: 'BTree-Collections';
|
||||
install: 'SyndicatedActors'.
|
||||
Installer squeaksource
|
||||
project: 'SqueakPhone';
|
||||
install: 'LinuxIO';
|
||||
install: 'SqueakPhone'.
|
||||
```
|
||||
|
||||
## Building/installing the system
|
||||
|
||||
Follow these steps after [installing the base Synit
|
||||
system](https://synit.org/book/install.html).
|
||||
|
||||
Check out the `squeak-phone` repository:
|
||||
|
||||
git clone https://git.syndicate-lang.org/tonyg/squeak-phone
|
||||
|
||||
Install [`squeaker`](https://github.com/tonyg/squeaker) so that the `squeaker` program is on
|
||||
your `$PATH`.
|
||||
|
||||
Run `make dev`. Eventually, a window should open with a transient Squeak image with a fully
|
||||
loaded set of SqueakPhone packages.
|
||||
|
||||
If that worked, try `make images/current`. Then, connect your phone, set up SSH to log in to
|
||||
it, and run
|
||||
|
||||
```shell
|
||||
./push-image-to-phone.sh PHONEHOSTNAME
|
||||
```
|
||||
|
||||
This will use `rsync` (which has to already have been installed with `apk add rsync` on the
|
||||
phone) to synchronise
|
||||
|
||||
- the `images/current/` image files
|
||||
- the `sounds/` folder
|
||||
- `squeak.pr`, the `syndicate-server` configuration responsible for defining and starting the
|
||||
Squeak [synit](https://synit.org/) service.
|
||||
|
||||
## Notes on working with PostmarketOS
|
||||
|
||||
### How to use pmbootstrap
|
||||
|
||||
Switching devices:
|
||||
|
||||
|
@ -29,7 +79,7 @@ Building for qemu-amd64:
|
|||
pmbootstrap install
|
||||
pmbootstrap qemu
|
||||
|
||||
## How to install on Samsung Galaxy S7
|
||||
### How to install on Samsung Galaxy S7
|
||||
|
||||
(See https://wiki.postmarketos.org/wiki/Installation_from_recovery_mode )
|
||||
|
||||
|
@ -40,7 +90,7 @@ Then run
|
|||
|
||||
pmbootstrap flasher --method adb sideload
|
||||
|
||||
## How to use RNDIS to connect via ssh over USB
|
||||
### How to use RNDIS to connect via ssh over USB
|
||||
|
||||
(See https://wiki.postmarketos.org/wiki/USB_Network )
|
||||
|
||||
|
@ -62,7 +112,7 @@ MAC address and assigning it at the link layer:
|
|||
sudo ip r add 172.16.0.0/16 dev eth0
|
||||
SSH_AUTH_SOCK= ssh user@172.16.42.1
|
||||
|
||||
## How to set up WiFi on a running instance
|
||||
### How to set up WiFi on a running instance
|
||||
|
||||
(See https://wiki.postmarketos.org/wiki/WiFi)
|
||||
|
||||
|
|
Loading…
Reference in New Issue