Browse Source

Revise README

Change-Id: I751e804be2c2511e3b901edcd15fbb436e652bfb
Simao Gomes Viana 6 months ago
parent
commit
d2f557c14f
1 changed files with 17 additions and 13 deletions
  1. 17
    13
      README.md

+ 17
- 13
README.md View File

@@ -38,7 +38,7 @@ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
38 38
 chmod a+x ~/bin/repo
39 39
 ```
40 40
 
41
-Now run following line as well and add it to your `~/.bashrc` file:
41
+Now add the directory to your PATH variable in your environment (e. g. by appending it to your `~/.bashrc`)
42 42
 
43 43
 ```bash
44 44
 export PATH="$HOME/bin:$PATH"
@@ -53,7 +53,7 @@ Ubuntu, Debian (apt): apt-get install git
53 53
 OpenSUSE: zypper install git
54 54
 Fedora: yum install git-all
55 55
 Gentoo: emerge --ask --verbose dev-vcs/git
56
-Archlinux: pacman -S git
56
+Arch Linux: pacman -S git
57 57
 ```
58 58
 
59 59
 The derivatives of these common distributions should also have the git package available, if you believe your distribution does not offer git in the default package repositories then you may consider [compiling and installing git from source](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-from-Source).
@@ -75,9 +75,8 @@ Now initialize a repo source tree, to do this please use following command:
75 75
 repo init -u https://git.halogenos.org/halogenOS/android_manifest.git -b XOS-8.1
76 76
 ```
77 77
 
78
-Then synchronize the source tree using repo, which will fetch the source of XOS. You should be warned that this is a procedure which downloads huge amounts (about 20 GB in total) of data, it may take hours to complete. Be prepared with something fun to do as will be waiting for a while or just listen to EDM.
79
-Note, that you will need more than just 20 GB of storage. The **download** amount of data is <20 GB, the final amount of storage needed, will be around 30-40 GB, and for building XOS, you will need at least additional 35 GB.
80
-To clarify: __Downloaded__ will be only 20 GB, and altogether (including the downloaded data) you will need about 90 GB of storage on your hard drive.
78
+Then synchronize the source tree using repo, which will fetch the source of XOS. You should be warned that this is a procedure which downloads huge amounts (about 20-30 GB in total) of 
79
+data, it may take hours to complete. Be prepared with something fun to do as will be waiting for a while or just listen to EDM.
81 80
 
82 81
 ```bash
83 82
 repo sync -c --no-tags --no-clone-bundle -f build/make external/xos
@@ -87,23 +86,30 @@ reposync
87 86
 
88 87
 #### __3. Building__
89 88
 
90
-__Note: The current changelog for XOS is here: https://github.com/halogenOS/android_vendor_xos/blob/XOS-8.1/Changelog.md__
91
-
92
-First, in order to build XOS you should execute the envsetup.sh script in your terminal/shell, this will set up and import all of the available device configurations for the ROM as well as giving you some fancy "macro" commands for your build enviroment. As such, in order to do this, run the command:
89
+First, in order to build XOS you should source the envsetup.sh script in your terminal/shell, this will set up and import all of the available device configurations for the ROM as well as giving you some fancy "macro" commands for 
90
+your build enviroment. As such, in order to do this, run the command:
93 91
 
94 92
 ```bash
95 93
 source build/envsetup.sh
96 94
 ```
97 95
 
96
+By running
97
+
98
+```bash
99
+breakfast <device>
100
+```
101
+
102
+you can fetch the device tree and its dependencies of devices hosted by us.
103
+
98 104
 Now, you should select and configure the build target by using the *lunch* command. Type 'lunch', and a list of the available devices and build targets will be offered, give it a whirl, it won't bite.
99 105
 
100 106
 Additionally here's a list of build types for your target device that you will likely encounter while running 'lunch'.
101 107
 
102 108
 | Build type	| Use |
103 109
 |:----------|:----------|
104
-| user	| The flavour usually for building final releases. |
105
-| userdebug |	Same as "user" but with adb enabled and more debuggable. |
106
-| eng	| Engineering build, enables shell root access, debuggability, adb, install engineering modules and is fully JIT enabled |
110
+| user	| The flavour usually for building final releases. We don't use this (at least not yet) because custom ROMs don't play very well with it. |
111
+| userdebug |	Same as "user" but with adb enabled and more debuggable. This is the default. Don't be scared by the `debug` part. |
112
+| eng	| Engineering build, enables shell root access, debuggability, adb, install engineering modules and is fully JIT enabled. Only use this for initial bringup and extensive debugging. |
107 113
 
108 114
 Before you start building, make sure that you have all necessary device-specific trees.
109 115
 Official trees, maintained by the team, can be retrieved using:
@@ -141,6 +147,4 @@ _Additional build notes : If you're bringing up a new device, our [wiki](https:/
141 147
 #### __4. Flashing__
142 148
 If you do not know how to flash an Android ROM then you probably shouldn't have followed this guide in the first place, or have a case of amnesia, but in the case that you do need a briefing then here's a short guide on flashing XOS: https://goo.gl/BB53SU
143 149
 
144
-##### _For those who know what they are doing: XOS is under development. You can 'sync&build' but there are no promises it will work 100% :P"._
145 150
 <br />
146
-###### To build using your GPU (400x faster) do: <code>export USE_GPU_FOR_BUILDS=true</code>

Loading…
Cancel
Save