Skip to content

GitLab

Commit 7bceff21 authored by Romain Hunault's avatar Romain Hunault
Browse files

Merge branch '93-documentation-for-olimex-and-pinebook-to-be-added' into 'master' 

Resolve "Documentation for Olimex and Pinebook to be added"

Closes #93

See merge request !75
parents 55e1a763 6f18063a
Hide whitespace changes
Inline Side-by-side
Showing with 495 additions and 7 deletions
_data/devices/a5y17lte.yml
View file @ 7bceff21
......@@ -40,10 +40,12 @@ sdcard: up to 256 GB
soc: Samsung Exynos 7880
storage: 32/64 GB
tree: android_device_samsung_a5y17lte
twrp_version: twrp-3.3.1-1
type: phone
upgrade_available: pie
vendor: Samsung
vendor_short: samsung
versions: [nougat]
versions: pie
width: 71.4 mm (2.81 in)
wifi: 802.11 a/b/g/n/ac
status: dev
......
_data/devices/chiron.yml
View file @ 7bceff21
......@@ -37,12 +37,17 @@ screen_res: 2160x1080
screen_tech: IPS LCD
sdcard:
soc: Qualcomm MSM8998 Snapdragon 835
stockupgrade: V11.0.3.0.PDEMIXM_20191022.0000.00_9.0_global (latest)
stockupgrade_tool: Mi flash
stockupgrade_toolver: 2017.4.25.0
storage: 64/128/256 GB
tree: android_device_xiaomi_chiron
twrp_version: 3.3.1-1
type: phone
upgrade_available: pie
vendor: Xiaomi
vendor_short: xiaomi
versions: [oreo]
versions: pie
width: 75.5 mm (2.97 in)
wifi: 802.11 a/b/g/n/ac, Dual-band, WiFi Direct, Hotspot
status: dev
......
_data/laptops/olimex.yml 0 → 100644
View file @ 7bceff21
architecture: A64
audio: 3.5mm headphone plug HDMI, internal stereo speakers, internal microphone
cameras: VGA 640x480, front
codename: olimex
cpu_freq: 1.2 GHz
nand: 16GB eMMC
wifi: WiFi 802.11 b/g/n
maintainers: []
manufacturer: olimex
name: Olimex teres (beta)
power: {removable: True, DC 5V @ 3A, capacity: 9500mAh 3.7V, tech: 'Li-ion'}
ram: 2GiB DDR3L @ 672 MHz
release: 2017-10
screen: 11"
screen_res: 1366x768
screen_tech: LCD
soc: A64
stockupgrade: http://images.ecloud.global/dev/teres/e-n-teres_20200309.gz
storage: µSD, NAND
status: beta
type: Laptop
usb: 2 USB2.0 Host, X USB2.0 OTG
video: HDMI (mini)
vendor: Olimex
versions: Nougat
_data/laptops/pinebook.yml 0 → 100644
View file @ 7bceff21
architecture: A64
audio: 3.5mm OD/1.35mm ID (5V 3A) Port stereo speaker, microphone ,headphone jack
bluetooth: 4.0
cameras: 0.3 MPx, Front-Facing
codename: pinebook
cpu_freq: 1.2 gHz
nand: 16GB of eMMC (upgradable)
wifi: WiFi 802.11bgn
maintainers: []
manufacturer: Pine64
name: Pinebook (beta)
power: {tech: Lithium Polymer, capacity: 10000mAH }
ram: 2GB LPDDR3 RAM
screen: 11.4"
screen_res: 1080p or 1366x768
screen_tech: IPS panel
soc: A64 Quad Core Mali 400 MP2 GPU
stockupgrade: http://images.ecloud.global/dev/pinebook/e-n-pinebook_20200309.gz
status: beta
type: Laptop
usb: 2x USB 2.0 Host
video: Mini HDMI
vendor: Pinebook
versions: Nougat
_includes/laptop_left.html 0 → 100644
View file @ 7bceff21
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bulma/0.7.5/css/bulma.css">
{% assign device = site.data.laptops[page.device] %}
<div class="tile is-parent is-12">
<article class="tile is-child">
<div class="content">
<h1 class="title is-2">{{ device.vendor }} {{ device.name }} - "{{ device.codename }}"</h1>
<br>
<br>
<div class="tile is-child is-8" id="install">
<h3 class="title is-4 is-spaced">Install</h3>
<p class="subtitle is-6">To install /e/OS on your {{ device.vendor }} {{ device.name }} - "{{ device.codename }}" <a href="{{ "devices/" | append: device.codename | append: "/install" | relative_url }}"> click here</a> </p>
</div>
<br>
<br>
{% if device.upgrade_available %}
<div class="tile is-child is-8" id="upgrade">
<h3 class="title is-4 is-spaced">Upgrade</h3>
<p class="subtitle is-6">To upgrade your {{ device.vendor }} {{ device.name }} - "{{ device.codename }}" to the {{ device.upgrade_available }} build of /e/OS <a href="{{ "devices/" | append: device.codename | append: "/upgrade" | relative_url }}"> click here</a> </p>
</div>
<br>
<br>
{% endif %}
<div class="tile is-child is-8" id="build">
<h3 class="title is-4 is-spaced">Build</h3>
<p class="subtitle is-6">Want to build the /e/OS for the {{ device.vendor }} {{ device.name }} - {{ device.codename }} ? <a href="{{ site.baseurl }}/how-tos/build-e"> Click here</a></p>
</div>
<br>
<br>
<div class="tile is-child is-8" id="not-working">
<h3 class="title is-4 is-spaced">What's not (yet) working</h3>
<p class="subtitle is-6">Please find issues opened by users on this device <a href="https://gitlab.e.foundation/groups/e/-/boards/12?scope=all&utf8=%E2%9C%93&state=opened&label_name%5B%5D={{device.codename}}">here</a> You can also track the
progress of the issue here.</p>
</div>
<br>
<br>
<div class="tile is-child is-8" id="bug">
<h3 class="title is-4 is-spaced">Have you found a bug?</h3>
<p class="subtitle is-6">Please report <a href="https://gitlab.e.foundation/e/management/issues/new">here</a></p>
</div>
<br>
<br>
<div class="tile is-child is-8" id="unsupported">
<h3 class="title is-4 is-spaced">Is your model not supported?</h3>
<p class="subtitle is-6">Contact us to <a href="https://community.e.foundation/c/e-devices/request-a-device">Request support </a>for your device</p>
<p class="subtitle is-6">The more the users requesting for a device / model the better the chances of it getting on the official list!!!</p>
</div>
</div>
</article>
</div>
_includes/laptop_right.html 0 → 100644
View file @ 7bceff21
{% assign device = site.data.laptops[page.device] %}
<br>
<br>
<div>
<img src="/images/devices/{{ device.codename }}.jpg" alt="" width="300px" height="350px" >
</div>
<br>
<br>
<div class="columns">
<div class="column">
<h4 class="title is-4 is-left">Device Information</h4>
</div>
</div>
{%- if device.release %}
<div class="columns">
<div class="column">
<strong>Released</strong>
</div>
<div class="column">
{%- if device.release.first -%}
{%- for model in device.release -%}
{%- assign release = model.first[1] | split: '-' -%}
{{ model.first[0] }}: {% include snippets/release.html -%}
{%- unless forloop.last -%}
<br/>
{% endunless %}
{%- endfor %}
{%- else %}
{% assign release = device.release | split: '-' -%}
{% include snippets/release.html %}
{%- endif %}
</div>
</div>
{%- endif %}
{% if device.carrier %}
<div class="columns">
<div class="column">
<strong>Carrier</strong>
</div>
<div class="column">
{{ device.carrier }}
</div>
</div>
{% endif %}
<div class="columns">
<div class="column">
<h4 class="title is-4 is-left">Device Specifications</h4>
</div>
</div>
{%- if device.soc %}
<div class="columns">
<div class="column">
<strong>SoC</strong>
</div>
<div class="column">
{{ device.soc }}
</div>
</div>
{%- endif %}
{%- if device.nand %}
<div class="columns">
<div class="column">
<strong>nand</strong>
</div>
<div class="column">
{{ device.nand }}
</div>
</div>
{%- endif %}
{%- if device.ram %}
<div class="columns">
<div class="column">
<strong>RAM</strong>
</div>
<div class="column">
{{ device.ram }}
</div>
</div>
{%- endif %}
{%- if device.architecture %}
<div class="columns">
<div class="column">
<strong>Architecture</strong>
</div>
<div class="column">
{%- if device.architecture.cpu -%}
CPU: {{ device.architecture.cpu }}<br/>
Android: {{ device.architecture.userspace }}
{%- else -%}
{{ device.architecture }}
{%- endif -%}
</div>
</div>
{%- endif %}
{%- if device.storage %}
<div class="columns">
<div class="column">
<strong>Storage</strong>
</div>
<div class="column">
{{ device.storage }}
</div>
</div>
{%- endif %}
{% if device.screen %}
<div class="columns">
<div class="column">
<strong>Screen</strong>
</div>
<div class="column">
{{ device.screen_res }} ({{ device.screen_ppi }} PPI)<br>{{ device.screen_tech }}
</div>
</div>
{% endif %}
{% if device.bluetooth %}
<div class="columns">
<div class="column">
<strong>Bluetooth</strong>
</div>
<div class="column">
{{ device.bluetooth }}
</div>
</div>
{% endif %}
{% if device.wifi %}
<div class="columns">
<div class="column">
<strong>Wi-Fi</strong>
</div>
<div class="column">
{{ device.wifi }}
</div>
</div>
{% endif %}
{% if device.cameras %}
<div class="columns">
<div class="column">
<strong>Camera</strong>
</div>
<div class="column">
{{ device.cameras }}
</div>
</div>
{% endif %}
<div class="columns">
<div class="column">
<h4 class="title is-4 is-left">/e/ OS Information</h4>
</div>
</div>
<div class="columns">
<div class="column">
<strong>Maintainers</strong>
</div>
<div class="column">
/e/OS Build Team
</div>
</div>
<div class="columns">
<div class="column">
<strong>Versions</strong>
</div>
<div class="column">
{{ device.versions}}
</div>
</div>
<div class="columns">
<div class="column">
<strong>Build Status</strong>
</div>
<div class="column">
{{ device.status }}
</div>
</div>
<br>
<br>
<strong>Disclaimer:</strong>
<p>We can not guarantee that all the device specific information on this page is 100% up to date or accurate. <a href="{{ site.baseurl }}/disclaimer/disclaimer)">Read more</a></p>
_includes/templates/laptop_build.md 0 → 100644
View file @ 7bceff21
{% assign laptop = site.data.laptops[page.laptop] %}
Build /e/
_includes/templates/laptop_info.md 0 → 100644
View file @ 7bceff21
{% assign laptop = site.data.laptops[page.laptop] %}
<section class="container">
<div class="left">
{% include laptop_left.html %}
</div>
<div class="right">
{% include laptop_right.html %}
</div>
</section>
_includes/templates/laptop_install.md 0 → 100644
View file @ 7bceff21
<div class="wrapper" markdown="1">
{% assign device = site.data.laptops[page.device] %}
## Install /e/OS on your {{ device.codename }} {{ device.type }}
### /e/OS code sources for this laptop :
{% if device.gitlocation %}
You can download the /e/OS for PineBook [here]( {{ device.gitlocation }} )
{% endif %}
### Download the Build
Get the /e/ OS build to flash on your {{ device.type }} [here]({{ device.stockupgrade }})
### Installation guide
{% if device.codename == 'pinebook' %}
{% include templates/laptop_install_pinebook.md %}
{% elsif device.codename == 'olimex' %}
{% include templates/laptop_install_olimex.md %}
{% else %}
Laptop not supported :(
{% endif %}
Please note: In case you run into issue with the installation steps or find any step missing please let us know by sending a mail to <support@e.email> and we will have the details added.
_includes/templates/laptop_install_olimex.md 0 → 100644
View file @ 7bceff21
<div class="wrapper" markdown="1">
On a Linux computer
Extract the .gz archive
Insert a MicroSD card with minimum 8 GB storage
In the konsole run the code
sudo fdisk -l
this will display your SD card on the Konsole .
It would show up like
/dev/sdX
Please be sure you have selected the correct SD Card, as the next step will delete all data from it.
> Warning : This search can also show your main hard disk so be very careful at this point to identify the SD card.
Now in the console type
sudo dd if=extacted-file-path of=/dev/sdX
where X will be the character that identifies your SD card and you got in the previous step
Insert the SDCard on your {{ device.codename }} laptop
Set the laptop to boot of the SDCard and reboot
Your /e/OS should now boot up on your {{ device.codename }} laptop...enjoy !!!
_includes/templates/laptop_install_pinebook.md 0 → 100644
View file @ 7bceff21
<div class="wrapper" markdown="1">
On a Linux computer
Extract the .gz archive
Insert a MicroSD card with minimum 8 GB storage
In the konsole run the code
sudo fdisk -l
this will display your SD card on the Konsole .
It would show up like
/dev/sdX
Please be sure you have selected the correct SD Card, as the next step will delete all data from it.
> Warning : This search can also show your main hard disk so be very careful at this point to identify the SD card.
Now in the console type
sudo dd if=extacted-file-path of=/dev/sdX
where X will be the character that identifies your SD card and you got in the previous step
Open the SD card in a FileManager
There would be multiple partitions
Go to the BOOT partition
modify the uEnv.txt file
Change the variable "pinebook_lcd_mode" to match your device
could be batch1, batch2 or 1080p
Depending on your LCD settings.
> In case the laptop does not boot then try a different setting
Your /e/OS should now boot up...enjoy !!!
pages/devices.md
View file @ 7bceff21
......@@ -3,13 +3,14 @@ layout: page
title: Smartphones
permalink: devices/
search: exclude
toc: true
---
## What's in /e/?
### What's in /e/?
Please check the [/e/ product description](../what-s-e)
## How to install /e/ on your smartphone?
### How to install /e/ on your smartphone?
In order to install /e/:
* check that your Smartphone is in the supported list given below
......@@ -22,11 +23,11 @@ In order to install /e/:
Can't find your Smartphone? Do a [device proposal here](https://community.e.foundation/c/e-devices/request-a-device) after checking it was not proposed earlier. Or do the work and become a device maintainer (send an email to [join@e.email](mailto:join@e.email), with a clear subject line (like: ROM Maintainer for device XYZ123).
## Smartphone build branch details
### Smartphone build branch details
Note: the v0.x-n branch is based on Nougat, the v0.x-o branch is based on "Oreo", the v0.x-p branch is based on "Pie". There are no differences between the three in term of "/e/ features".
## Smartphones list
### Smartphones list
{% assign devices = "" | split: " " %}
{% for device in site.data.devices %}
......@@ -42,7 +43,7 @@ Note: the v0.x-n branch is based on Nougat, the v0.x-o branch is based on "Oreo"
{%- if device.vendor != lastVendor %}
{%- assign lastVendor = device.vendor %}
### {{ lastVendor }}
#### {{ lastVendor }}
| Vendor | Name | Codename | OS Version |
|--------|------|----------|----------|
......@@ -53,3 +54,51 @@ Note: the v0.x-n branch is based on Nougat, the v0.x-o branch is based on "Oreo"
Smartphones supported: {{ nbDevices }}
# Laptops
### How to install /e/ on your laptop ?
In order to install /e/:
* check that your Laptop is in the supported list given below
* ensure that you have an /e/ account (for /e/ online services such as mail, drive, calendar...). You can register for a [free /e/ acount here](../create-an-ecloud-account)
* proceed to installation
* find some [community support](https://e.foundation/get-support/#help)
* [report issues here](../how-tos/report-an-issue)
* [report your experience here](../testimonies)
* [contribute to the project!](../projects-looking-for-contributors)
Can't find your laptop? Do a [device proposal here](https://community.e.foundation/c/e-devices/request-a-device) after checking it was not proposed earlier. Or do the work and become a device maintainer (send an email to [join@e.email](mailto:join@e.email), with a clear subject line (like: ROM Maintainer for device XYZ123).
### Laptop build branch details
Note: the v0.x-n branch is based on Nougat, the v0.x-o branch is based on "Oreo", the v0.x-p branch is based on "Pie". There are no differences between the three in term of "/e/ features".
### Laptop list
{% assign laptops = "" | split: " " %}
{% for laptop in site.data.laptops %}
{% assign laptops = laptops | push: laptop[1] %}
{% endfor %}
{% assign sorted = laptops | sort_natural: 'name' | sort_natural: 'vendor' %}
{% assign lastVendor = "" %}
{% assign nbLaptops = 0 %}
{%- for laptop in sorted %}
{%- assign nblaptops = nblaptops | plus:'1' %}
{%- if device.vendor != lastVendor %}
{%- assign lastVendor = device.vendor %}
| Vendor | Name | Codename | OS Version |
|--------|------|----------|----------|
{%- endif %}
| {{laptop.vendor}} | {{laptop.name}} {%- if laptop.is_beta %} (beta) {%- endif %} | [{{laptop.codename}}]({{laptop.codename}}) | {{ laptop.versions }} |
{%- endfor %}
Laptops supported: {{ nblaptops }}
pages/info/olimex.md 0 → 100644
View file @ 7bceff21
---
sidebar: home_sidebar
title: Info about Olimex Laptops
folder: info
layout: default
permalink: /devices/olimex
device: olimex
---
{% include templates/laptop_info.md %}
pages/info/pinebook.md 0 → 100644
View file @ 7bceff21
---
sidebar: home_sidebar
title: Info about PineBook Laptops
folder: info
layout: default
permalink: /devices/pinebook
device: pinebook
---
{% include templates/laptop_info.md %}
pages/install/olimex.md 0 → 100644
View file @ 7bceff21
---
sidebar: home_sidebar
title: Install /e/ on Olimex Laptops
folder: install
layout: default
permalink: /devices/olimex/install
device: olimex
---
{% include templates/laptop_install.md %}
pages/install/pinebook.md 0 → 100644
View file @ 7bceff21
---
sidebar: home_sidebar
title: Install /e/ on PineBook Laptops
folder: install
layout: default
permalink: /devices/pinebook/install
device: pinebook
---
{% include templates/laptop_install.md %}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment