Skip to content

Commit

Permalink
Deploying to gh-pages from @ b9fa8c2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
SyedAhkam committed Oct 9, 2023
1 parent 07a2066 commit 6282878
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 4 deletions.
24 changes: 23 additions & 1 deletion print.html
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,29 @@ <h2 id="example-2"><a class="header" href="#example-2">Example</a></h2>
<div style="break-before: page; page-break-before: always;"></div><h1 id="android-emulator"><a class="header" href="#android-emulator">android emulator</a></h1>
<p>TODO</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="dot-android"><a class="header" href="#dot-android">Dot Android</a></h1>
<p>TODO</p>
<p>It refers to the <code>.android</code> file in your project root directory.</p>
<p>It is used to store certain configuration settings for the Android CLI. It is created when you either initialize a new project or run <code>android link</code>.</p>
<pre><code class="language-ron">// DO NOT MODIFY; Generated by Android CLI for internal usage.
(
project_name: &quot;testing&quot;,
package_id: &quot;com.example.testing&quot;,
gen_at_version: &quot;0.1.0&quot;,
main_activity_name: &quot;MainActivity&quot;,
)
</code></pre>
<h2 id="file-format"><a class="header" href="#file-format">File format</a></h2>
<p>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 <a href="https://github.com/ron-rs/ron">here</a>.</p>
<h2 id="fields"><a class="header" href="#fields">Fields</a></h2>
<h3 id="project-name"><a class="header" href="#project-name">Project name</a></h3>
<p>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.</p>
<h3 id="package-id"><a class="header" href="#package-id">Package ID</a></h3>
<p>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 <code>com.example.appname</code>.</p>
<h3 id="gen-at-version"><a class="header" href="#gen-at-version">Gen at version</a></h3>
<p>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.</p>
<h3 id="main-activity-name"><a class="header" href="#main-activity-name">Main activity name</a></h3>
<p>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 <code>MainActivity</code>.</p>
<h2 id="usage"><a class="header" href="#usage">Usage</a></h2>
<p>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.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="frequently-asked-questions"><a class="header" href="#frequently-asked-questions">Frequently Asked Questions</a></h1>
<h2 id="1-isnt-there-already-an-android-tool-that-ships-with-the-android-sdk"><a class="header" href="#1-isnt-there-already-an-android-tool-that-ships-with-the-android-sdk">1. Isn't there already an <code>android</code> tool that ships with the android SDK?</a></h2>
<p>Yes, there is an <code>android</code> bash script that comes with the Android SDK. However, it has been deprecated, and its functionalities have been absorbed into Android Studio, making it the only supported option for Android development. This decision has frustrated developers who prefer to use a CLI to manage their projects.</p>
Expand Down
24 changes: 23 additions & 1 deletion reference/dot-android.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,29 @@ <h1 class="menu-title">Android CLI</h1>
<div id="content" class="content">
<main>
<h1 id="dot-android"><a class="header" href="#dot-android">Dot Android</a></h1>
<p>TODO</p>
<p>It refers to the <code>.android</code> file in your project root directory.</p>
<p>It is used to store certain configuration settings for the Android CLI. It is created when you either initialize a new project or run <code>android link</code>.</p>
<pre><code class="language-ron">// DO NOT MODIFY; Generated by Android CLI for internal usage.
(
project_name: &quot;testing&quot;,
package_id: &quot;com.example.testing&quot;,
gen_at_version: &quot;0.1.0&quot;,
main_activity_name: &quot;MainActivity&quot;,
)
</code></pre>
<h2 id="file-format"><a class="header" href="#file-format">File format</a></h2>
<p>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 <a href="https://github.com/ron-rs/ron">here</a>.</p>
<h2 id="fields"><a class="header" href="#fields">Fields</a></h2>
<h3 id="project-name"><a class="header" href="#project-name">Project name</a></h3>
<p>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.</p>
<h3 id="package-id"><a class="header" href="#package-id">Package ID</a></h3>
<p>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 <code>com.example.appname</code>.</p>
<h3 id="gen-at-version"><a class="header" href="#gen-at-version">Gen at version</a></h3>
<p>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.</p>
<h3 id="main-activity-name"><a class="header" href="#main-activity-name">Main activity name</a></h3>
<p>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 <code>MainActivity</code>.</p>
<h2 id="usage"><a class="header" href="#usage">Usage</a></h2>
<p>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.</p>

</main>

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

0 comments on commit 6282878

Please sign in to comment.