Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml deleted file mode 100644 index 2ac31bb..0000000 --- a/.github/workflows/build-and-test.yml +++ /dev/null @@ -1,23 +0,0 @@ -on: - push: - branches: - - master - pull_request: - branches: - - master - -name: Build and test - -jobs: - build-and-test: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: actions-rs/toolchain@v1 - with: - toolchain: stable - - name: Build and test - run: | - cargo build --release - cargo test - \ No newline at end of file diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml deleted file mode 100644 index 204daba..0000000 --- a/.github/workflows/deploy-docs.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Deploy Docs - -on: - push: - branches: [ master ] - pull_request: - branches: [ master ] - -jobs: - build: - name: Build, Test and Deploy - runs-on: ubuntu-latest - permissions: - contents: write # To push a branch - pull-requests: write # To create a PR from that branch - steps: - - uses: actions/checkout@v2 - - uses: actions-rs/toolchain@v1 - with: - toolchain: stable - - run: (test -x $HOME/.cargo/bin/mdbook || cargo install --vers "^0.4" mdbook) - - run: mdbook build docs && mdbook test docs # In case of custom book path: mdbook build path/to/mybook && mdbook test path/to/mybook - - uses: JamesIves/github-pages-deploy-action@4.1.7 - with: - branch: gh-pages # The branch the action should deploy to. - folder: docs/book # The folder the action should deploy. \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 8e4fd56..0000000 --- a/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -/target - -# Used for testing -/out diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..f173110 --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +This file makes sure that Github Pages doesn't process mdBook's output. diff --git a/404.html b/404.html new file mode 100644 index 0000000..521923b --- /dev/null +++ b/404.html @@ -0,0 +1,221 @@ + + +
+ + +This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +USAGE:
+ android build [OPTIONS]
+
+OPTIONS:
+ -h, --help Print help information
+ -r, --release Should build in release mode
+
+For now, it just execs ./gradlew assemble[Debug|Release].
$ android build
+
+$ android build --release
+
+
+ USAGE:
+ android devices
+
+OPTIONS:
+ -h, --help Print help information
+
+Executes adb devices and returns the output.
$ android devices
+
+
+ Not implemented yet.
+ +USAGE:
+ android install [OPTIONS]
+
+OPTIONS:
+ -h, --help Print help information
+ -r, --release Should install release APK
+
+Executes adb install under the hood and simply returns the output.
$ android install
+
+$ android install --release
+
+
+ USAGE:
+ android launch
+
+OPTIONS:
+ -h, --help Print help information
+
+It requests ADB to launch the configured main activity of the installed app onto the connected device or emulator, effectively running our app.
+$ android launch
+
+
+ USAGE:
+ android run [OPTIONS]
+
+OPTIONS:
+ -h, --help Print help information
+ -r, --release Should build in release mode
+
+It is a combination of three commands, android build, android install and android launch giving you an illusion of a single operation being executed.
$ android run
+
+$ android run --release
+
+
+ USAGE:
+ android shell
+
+OPTIONS:
+ -h, --help Print help information
+
+It simply asks adb to attach a shell to your connected android device / emulator by executing adb shell.
$ android shell
+
+
+ android tool that ships with the android SDK?Yes, there is an android 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.
Not necessarily. If you go to Android Studio download page and scroll down enough you'll see a section named 'Command line tools only'. Just grab that and there's no need for Android Studio.
+Well yes and no, I eventually intend to build an interface on top of the existing commands in the near future to make actions more controllable and user-friendly as a whole. For example: imagine a prompt which lets you choose which device to run your project on, and even offer launching an emulator right there. there's so many possibilities.
+ +There are mainly two ways to get started -- either create a new project or link to an existing android project.
+You may create or initialize a project using
+$ android create
+
+And then answer a few prompts:
+++The template project that this is based upon lives here. Open for contributions.
+
After creating the project, you can start editing the source and run the project.
+$ cd <dest>
+$ android run
+
+If you already have an android project bootstrapped, you will need to link it.
+$ android link
+
+++You might need to dig into your own source code to figure out the appropriate prompt values. Especially the package identifier and main activity class name.
+
All this essentially does is create a .android file which is then relied upon by the CLI for future operations.
+ +$ cargo install android-cli
+
+$ cargo install --git https://github.com/SyedAhkam/android-cli.git
+
+Haven't set this up yet. Coming soon.
+Ensure you have the latest stable version of Rust installed (with Cargo). Then, clone the repository and run the following command from the root of the repository:
+$ cargo install --path .
+
+++ +After installation, you should have access to the
+androidbinary from your choice of shell.
++⚠ Still️ in early development. Bugs may arise.
+
Android CLI is a powerful tool that simplifies and streamlines the Native Android development process.
+It provides a single interface for developers to create, build, and release Android applications without the need for cumbersome IDEs like Android Studio.
+Github Project can be found here
+ +