From b9fa8c2514477af5f6a165a51d4baad28819e617 Mon Sep 17 00:00:00 2001 From: SyedAhkam Date: Tue, 10 Oct 2023 04:30:11 +0530 Subject: [PATCH] feat: document `.android` reference in docs --- docs/src/reference/dot-android.md | 40 ++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/docs/src/reference/dot-android.md b/docs/src/reference/dot-android.md index c04f4ea..5c79d22 100644 --- a/docs/src/reference/dot-android.md +++ b/docs/src/reference/dot-android.md @@ -1,3 +1,41 @@ # Dot Android -TODO \ No newline at end of file +It refers to the `.android` file in your project root directory. + +It is used to store certain configuration settings for the Android CLI. It is created when you either initialize a new project or run `android link`. + +```ron +// DO NOT MODIFY; Generated by Android CLI for internal usage. +( + project_name: "testing", + package_id: "com.example.testing", + gen_at_version: "0.1.0", + main_activity_name: "MainActivity", +) +``` + +## File format + +The file is a RON file (Rusty Object Notation). It is kinda like JSON, but with a heavy rusty influence. You can read more about it [here](https://github.com/ron-rs/ron). + +## Fields + +### Project name + +The name of the project. This is the name you gave when you initialized the project. Usually, it is the name of the directory that contains your project. + +### Package ID + +This is the package identifier or package name of your app. The convention comes from Java apps. It is used to uniquely identify your app on the device and on the Play Store. It is usually in the form of `com.example.appname`. + +### Gen at version + +This is the version of the Android CLI that generated this file. It is used to determine if the file is compatible with the current version of the CLI. This is used to prevent breaking changes from breaking your project. + +### Main activity name + +This is the name of the main activity of your app. This is the activity that is launched when your app is opened. It is usually left untouched as `MainActivity`. + +## Usage + +It is not recommended to modify this file manually. It is generated and updated by the CLI. In the future, the CLI will be able to perform migrations on your project and update this file for you automatically. \ No newline at end of file