Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 2.81 KB

README.mkdn

File metadata and controls

101 lines (76 loc) · 2.81 KB

CraftRom OS

===========

Getting started

To get started with Android/CraftRom OS, you'll need to get familiar with Source Control Tools.

To initialize your local repository using the CraftRom OS trees, use a command like this:

repo init -u https://github.com/craftrom-os/manifest.git -b uther --git-lfs

Then to sync up:

repo sync -c --force-sync --optimized-fetch --no-tags --no-clone-bundle --prune -j$(nproc --all)

Preparing your system to build

Installing git:

sudo apt install git

Running configuration script:

cd ~/
git clone https://github.com/akhilnarang/scripts
cd scripts
./setup/android_build_env.sh

Create the directories

You’ll need to set up some directories in your build environment. To create them:

mkdir -p ~/bin
mkdir -p ~/android/craft

The ~/bin directory will contain the git-repo tool (commonly named “repo”) and the ~/android/craft directory will contain the source code of CraftRom OS.

Install the repo command

Enter the following to download the repo binary and make it executable (runnable):

curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repo

Put the ~/bin directory in your path of execution

In recent versions of Ubuntu, ~/bin should already be in your PATH. You can check this by opening ~/.profile with a text editor and verifying the following code exists (add it if it is missing):

# set PATH so it includes user's private bin if it exists
if [ -d "$HOME/bin" ] ; then
    PATH="$HOME/bin:$PATH"
fi

Then, run source ~/.profile to update your environment.

Configure git

Given that repo requires you to identify yourself to sync Android, run the following commands to configure your git identity:

git config --global user.email "[email protected]"
git config --global user.name "Your Name"

Building the source

The source at CraftRom OS is well configured for building.

Initiate the build with:

. build/envsetup.sh

Prepare your device with:

breakfast $device

Then fire it off with:

mka craft

CraftRom OS Build Flags

This section contains a list of build flags that allow you to include or exclude specific prebuilts, Runtime Resource Overlays (RROs), and device properties in the Craftrom OS.

Note: To configure these flags for a particular device, make the necessary adjustments in the lineage_codename.mk file of your device tree.

Flag Use Default Value
TARGET_GCAM_SUPPORTED Indicates if the target supports Google Camera Go true