Skip to content

Commit eb02a8d

Browse files
readme: Re-format and fix grammar
The $ within the bash code snippets looks nice, but makes copying from the GitHub WebUI directly to the terminal unfeasible. OTA probably belongs within the maintainer category, as it is a requirement for maintainership OTA was gramatically corrected, by adding a "you" in the first sentence
1 parent a46a9d8 commit eb02a8d

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.mkdn

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,42 +17,44 @@ sudo apt install bc bison build-essential ccache curl flex g++-multilib gcc-mult
1717
Install Repo tool
1818
```bash
1919
# Make a directory where Repo will be stored and add it to the path
20-
$ mkdir ~/bin
21-
$ PATH=~/bin:$PATH
20+
mkdir ~/bin
21+
PATH=~/bin:$PATH
2222

2323
# Download Repo itself
24-
$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
24+
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
2525

2626
# Make Repo executable
27-
$ chmod a+x ~/bin/repo
27+
chmod a+x ~/bin/repo
2828
```
2929

3030
### 1.2 Initializing Repo ###
3131

3232
```bash
3333
# Create a directory for the source files
3434
# This can be located anywhere (as long as the fs is case-sensitive)
35-
$ mkdir crDroid
36-
$ cd crDroid
35+
mkdir crDroid
36+
cd crDroid
3737

3838
# Install Repo in the created directory
39-
$ repo init -u https://github.com/crdroidandroid/android.git -b 16.0 --git-lfs --no-clone-bundle
39+
repo init -u https://github.com/crdroidandroid/android.git -b 16.0 --git-lfs --no-clone-bundle
4040
```
4141

42+
### 1.3 Syncing build environment ###
43+
4244
This is what you will run each time you want to pull in upstream changes. Keep in mind that on your
4345
first run, it is expected to take a while as it will download all the required Android source files
4446
and their change histories.
4547

4648
```bash
4749
# Let Repo take care of all the hard work
48-
$ repo sync
50+
repo sync
4951
```
5052

5153
```bash
5254
# Run to prepare our devices list
53-
$ . build/envsetup.sh
55+
. build/envsetup.sh
5456
# ... now run
55-
$ brunch devicecodename
57+
brunch devicecodename
5658
```
5759

5860
## 2. Contributions ##
@@ -63,6 +65,12 @@ To submit changes/patches, please send a pull request on GitHub. We will review
6365

6466
Make sure you can follow our [rules-and-guidelines](https://github.com/crdroidandroid/rules-and-guidelines), then if all is right, just message Gabriel over [Telegram](https://telegram.me/gwolf2u) with the device you want to maintain.
6567

68+
### 3.1 OTA ###
69+
So you posted on forums and your users are enjoying your build.
70+
Well you can help out your users by letting them know when you fix stuff in your builds with the help of our OTA app.
71+
Since crDroid Oreo, if you want to be on the official maintainers list, you'll need to provide OTA access.
72+
You can set it up really easy by reading [android_vendor_crDroidOTA](https://github.com/crdroidandroid/android_vendor_crDroidOTA/blob/16.0/README.md) repo description.
73+
6674
## 4. crDroid features / overlays, translations, forum template and OTA ##
6775

6876
### 4.1 crDroid features / overlays ###
@@ -85,8 +93,3 @@ Build ready? Tested all features and translations are smooth?
8593
Why not share your build over your beloved forums?
8694
To do so, we have made a [small template](https://github.com/crdroidandroid/crdroid_features/blob/16.0/ForumPostTemplate) to help out. Just edit what you need and let the downloads roll. :sunglasses:
8795

88-
### 4.4 OTA ###
89-
So posted on forums and your users are enjoying your build.
90-
Well you can help out your users by letting them know when you fix stuff in your builds with the help of our OTA app.
91-
Since crDroid Oreo, if you want to be on the official maintainers list, you'll need to provide OTA access.
92-
You can set it up really easy by reading [android_vendor_crDroidOTA](https://github.com/crdroidandroid/android_vendor_crDroidOTA/blob/16.0/README.md) repo description.

0 commit comments

Comments
 (0)