Skip to content

Commit 5a494f8

Browse files
authored
add porting in a nutshell car analogy (#157)
* add porting in a nutshell car analogy * rephrase intro sentence to use 'porting' * remove portin in a nutshell from first steps * add porting in a nutshell to start page and fix smaller wording errors
1 parent 0e6f1c0 commit 5a494f8

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

index.rst

+13-9
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,21 @@
22
Halium
33
======
44

5-
Welcome to the documentation for `Halium`_, the collaborative project to unify the Hardware Abstraction Layer for projects which run GNU/Linux on mobile devices with pre-installed Android.
5+
Welcome to the `Halium`_ porting guide. Halium is a collaborative project to unify the Hardware Abstraction Layer for projects which run GNU/Linux on mobile devices with pre-installed Android.
6+
7+
What is porting about - in a nutshell
8+
-------------------------------------
9+
Think of your device as a car. You have got a petrol car (Android). You want to put in an electric driven engine (target OS). In the garage you are told you can put in a diesel engine (e.g. Lineage OS). Fine, so your car is capable of exchanging the engine. Now you need to get all parts for your new engine (kernel, firmware, ...), assemble them and build them into your car (porting). And because every car's chassis is different, you can not use the parts of a Ford to use with a Porsche. That's why every type of car needs its own engine (port). Got it?
610

711
Contents
812
========
913

10-
14+
1115
.. toctree::
1216
:maxdepth: 1
1317
:caption: Porting Guide
1418
:name: sec-porting
15-
19+
1620
porting/first-steps
1721
porting/get-sources
1822
porting/build-sources
@@ -23,24 +27,24 @@ Contents
2327
:maxdepth: 1
2428
:caption: Distribution
2529
:name: sec-distribution
26-
30+
2731
Distribution
28-
32+
2933
.. toctree::
3034
:maxdepth: 1
3135
:caption: Supplementary Information
3236
:name: sec-supplemental
33-
37+
3438
supplementary/about-this-chapter
3539
supplementary/devices/index
3640
supplementary/hardware-enablement
3741
supplementary/how-to-document
38-
42+
3943
.. toctree::
4044
:maxdepth: 1
41-
:caption: Project
45+
:caption: Project
4246
:name: sec-planning
43-
47+
4448
project/Scope
4549
project/Related-projects
4650
project/Planning

0 commit comments

Comments
 (0)