Update README.md

This commit is contained in:
Sushrut Gupta 2021-08-05 17:39:39 +05:30 committed by GitHub
parent 2db3aad217
commit 8d7abdade5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

101
README.md
View file

@ -1,61 +1,58 @@
## Submitting Patches ## # fox_6.0 (android-6.0) Based Manifest for OrangeFox Recovery #
------------------
Our project is open source, and patches are always welcome!
You can send patches by using:
Pull request, right here on git. ### Notes ###
- This is NOT an Official Manifest.
- This Manifest uses the Official twrp-6.0 source, with a Patched Build System for OrangeFox, and the OFFICIAL OrangeFox `bootable/recovery` and `vendor/recovery` trees.
- The Build Environment Setup Guide Below, is the same till Step Number 4 (except for apt). For Other Linux Distros, Read [This](https://github.com/akhilnarang/scripts.git).
Contact us on irc, Network: freenode, Channel: #twrp
## Maintaining Authorship ##
----------------------
Mainting authorship is a very important aspect of working with Open Source code. If you wish to submit a patch/fix
from anywhere else (another ROM, project, etc.), it is imperative that you maintain the ownership of the person whose
work you're seeking to include. Doing so will ensure that credit is given where it is deserved, and the [prinicples of open source](http://opensource.org/docs/osd)
are upheld. Your contribution to the project will still be recognized as you will forever be listed as the committer.
If you manually cherry pick a patch/fix then you will need to add the original author prior to pushing to our [gerrit](https://gerrit.omnirom.org).
This is a very easy task to perform, and is usually done after you commit a patch/fix locally. This is accomplished
after you type in `git commit -a` , type in the commit message and save. You would then do the following:
## How to Build ##
1. ### Set up the Build Environment ###
```bash ```bash
git commit --amend --author "Author <email@address.com>" cd ~
sudo apt install git aria2 -y
git clone https://github.com/akhilnarang/scripts.git ~/scripts
cd ~/scripts
sudo bash setup/android_build_env.sh
``` ```
2. ### Sync the OrangeFox (fox_6.0) Source ###
So it should look like this once you get all of the author's information
```bash ```bash
git commit --amend --author "Spencer McGillicuddy <spencer.the.bestest@gmail.com>" mkdir ~/OrangeFox_6
cd ~/OrangeFox_6
repo init -u https://github.com/OrangeFoxRecovery/fox-6.0_manifest.git -b fox_6.0
repo sync -j$(nproc --all) --force-sync
``` ```
#### Tip: ####
Alternatively, adding as part of the original `git commit` message is preferred and done like the following: - Use ```repo init --depth=1 -u https://github.com/OrangeFoxRecovery/fox-6.0_manifest.git -b fox_6.0``` to initialize a Shallow Clone to save Disk Space.
3. ### Place Trees and Kernel
#### For Example: (Yours may be Different) ####
```bash ```bash
git commit --author="Author <email@address.com>" -m "[commit message]" cd ~/OrangeFox_6
git clone https://github.com/OrangeFoxRecovery/device_samsung_fortuna3g.git device/samsung/fortuna3g
``` ```
4. ### Build it! ###
This saves time, and when part of your normal routine, prevents the infamous "ermahgerd I forgot to add authorship - ```bash
let me fix it because I was found out!" message. cd ~/OrangeFox_6
. build/envsetup.sh
export ALLOW_MISSING_DEPENDENCIES=true
## Getting Started ## export FOX_USE_TWRP_RECOVERY_IMAGE_BUILDER=1
--------------- export LC_ALL="C"
export OF_LEGACY_SHAR512=1
To get started with OMNI sources to build TWRP, you'll need to get lunch omni_<device>-eng
familiar with [Git and Repo](https://source.android.com/source/using-repo.html). mka recoveryimage
```
To initialize your local repository using the OMNIROM trees to build TWRP, use a command like this: #### Notes: ####
- If you are getting errors like "Keymaster2" during Compilation, run ```export OF_DISABLE_KEYMASTER2=1``` and then Build Again.
repo init -u git://github.com/minimal-manifest-twrp/platform_manifest_twrp_omni.git -b twrp-6.0 5. ### Take your OrangeFox Build ###
#### Find your build: ####
To initialize a shallow clone, which will save even more space, use a command like this: ```bash
cd ~/OrangeFox_6
repo init --depth=1 -u git://github.com/minimal-manifest-twrp/platform_manifest_twrp_omni.git -b twrp-6.0 ls out/target/product/*/
```
Then to sync up: 6. ### Enjoy! ###
Now enjoy the Latest OrangeFox Recovery on an old device too! :)
repo sync ## Credits: ##
- TeamWin - for TWRP Manifest
Then to build: - The OrangeFox Team - for the Amazing Recovery!
- [@DarthJabba9](https://gitlab.com/DarthJabba9) - For the fox_6.0 Build System Patch File.
cd <source-dir>; . build/envsetup.sh; lunch omni_<device>-eng; mka recoveryimage - [@Sushrut1101](https://github.com/Sushrut1101) - For adding the patches in a proper Manifest.