Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Verified Commit e6068ac4 authored by Nicolas Gelot's avatar Nicolas Gelot
Browse files

Update README

parent 20ca1996
Loading
Loading
Loading
Loading
+6 −6
Original line number Diff line number Diff line
# /e/OS Installer

Install /e/OS from a chromium-based browser
Install /e/OS on a device from a chromium-based browser

- **Online instance**: [https://e.foundation/installer](https://e.foundation/installer)
- **Documentation**: [https://doc.e.foundation/eos-installer](https://doc.e.foundation/eos-installer)
- **Source code**: [https://gitlab.e.foundation/e/devices/eos-installer](https://gitlab.e.foundation/e/devices/eos-installer)

[[_TOC_]]

## Features

- detect the device
@@ -19,11 +17,11 @@ Install /e/OS from a chromium-based browser

1. Get the docker image: `docker pull registry.gitlab.e.foundation/e/devices/eos-installer:latest`
2. Run a docker container
    - Windows: `docker run -v "%cd%"\src:/app/src -p 127.0.0.1:3000:3000 eos-installer`
    - Linux: `docker run -v "$(pwd)/src:/app/src" -p 127.0.0.1:3000:3000 eos-installer`
    - Windows: `docker run -p 3000:80 eos-installer`
    - Linux: `docker run -p 3000:80 eos-installer`
3. The app is available at `http://localhost:3000/`

## Supportted devices
## Supported devices

The list of supported devices is available [here](https://gitlab.e.foundation/e/devices/eos-installer/-/tree/main/app/public/resources).

@@ -39,8 +37,10 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).

Using:
- vanilla Javascript, CSS and HTML
- vite as builder
- Docker for packaging

Libraries:
- fastboot.js (License: MIT): https://github.com/kdrag0n/fastboot.js/ 
- ya-webadb (License: MIT): https://github.com/yume-chan/ya-webadb
- see [package.json](https://gitlab.e.foundation/e/devices/eos-installer/-/blob/main/app/package.json)