Skip to content

Commit 7e09768

Browse files
committed
docs: Refactor install by mentioning hadk.tools and improving layout
[docs] Refactor install by mentioning hadk.tools and improving layout. Resolves #6 Signed-off-by: Björn Bidar <[email protected]>
1 parent 3948c63 commit 7e09768

File tree

2 files changed

+56
-8
lines changed

2 files changed

+56
-8
lines changed

INSTALL.org

+55-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,58 @@
1-
#+TITLE: Sailfish OS Sony Xperia Build instructions
1+
#+TITLE: Sailfish OS Sony Xperia Build and install instructions
22
#+LANGUAGE: english
3+
* Intro
34

4-
Building is mostly the same as for official Sony ports.
5-
You only have to adjust the setup of ~hadk.env~ with values
6-
appropriate for your device.
5+
This file tracks the install instructions for our ports
76

8-
The official instructions for building you can find here:
9-
+ Android 10 based :: https://docs.sailfishos.org/Develop/HW_Adaptation/Sailfish_X_Xperia_Android_10_Build_and_Flash/
10-
+ Android 11 based (WIP) :: https://github.com/sailfishos/docs.sailfishos.org/pull/21
7+
* Prebuilds
8+
9+
Download the zip file attached to the latest release and follow the /flashing-readme.txt/
10+
included in the archive.
11+
12+
If you need additional help please read the offical flashing instructions:
13+
https://jolla.com/sailfishxinstall/
14+
15+
In case any problems arise please [[https://github.com/SailfishOS-SonyXperia/bug_tracker/issues/new/choose][open an issue]] in the repository.
16+
17+
* Built it your self
18+
19+
** Vanilla builds
20+
21+
Building this way is mostly the same as for official Sony ports.
22+
You only have to adjust the setup of ~hadk.env~ with values
23+
appropriate for your device (you get them by reading [[./README.org]]).
24+
25+
The official instructions for building you can find here:
26+
+ [[https://docs.sailfishos.org/Develop/HW_Adaptation/Sailfish_X_Xperia_Android_11_Build_and_Flash/][Android 10]]
27+
+ [[https://docs.sailfishos.org/Develop/HW_Adaptation/Sailfish_X_Xperia_Android_11_Build_and_Flash/][Android 11]]
28+
29+
** HADK tools build
30+
31+
HADK-tools based builds are build split into different units per section that is build.
32+
33+
Each section depends on the section before being build before.
34+
35+
The sections are in that order:
36+
+ sfos.hybris.hal.sony.kernel.hadk :: Kernel for Sony based Sailfish OS ports
37+
+ mer.hybris.hal.pie.hadk :: hybris-hal
38+
+ sfos.hybris.hal.img.boot.hadk :: droid-hal-img-boot
39+
+ sfos.mw.hadk :: Packages that use device specific sources or are just device specific middleware
40+
+ sfos.mw.pulseaudio.hadk or sfos.mw.pulseaudio.jb2q.hadk :: Pulseaudio modules needed for Hybris based ports
41+
+ sfos.droidmedia.audiopolicy.hadk :: Droidmedia
42+
+ sfos.droid.syspart.hadk :: Droid-system
43+
+ mer.droid.configs.hadk :: Droid-configs
44+
+ sfos.droid.version.hadk :: Droid-Version
45+
+ mk.image.hadk :: Building the final image for the device
46+
47+
When doing full builds these are ran through in that order.
48+
49+
Setup /hadk-tools/ and pass the device for file your device variant to hadk.tools:
50+
51+
#+begin_src sh
52+
hadk.source -f sony.$variant.hadk
53+
hadk.source -f sony.$build.hadk
54+
#+end_src
55+
56+
Depending on your machine this can take some time!
57+
58+
After this you can your device using the /./flash.sh/ included the zip file.

README.org

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#+TITLE: Sailfish OS Sony Xperia community ports - Bug Tracker
2-
* Build Instructions
2+
* Build and install Instructions
33
Follow [[./INSTALL.org]].
44
* Supported devices
55

0 commit comments

Comments
 (0)