Skip to content

Commit

Permalink
Update and add READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
MarijnS95 committed Sep 11, 2023
1 parent 8ce097b commit 558adff
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
12 changes: 11 additions & 1 deletion cargo-apk/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# cargo apk

[![Actions Status](https://github.com/rust-mobile/cargo-apk/actions/workflows/rust.yml/badge.svg)](https://github.com/rust-mobile/cargo-apk/actions)
[![Latest version](https://img.shields.io/crates/v/cargo-apk.svg?logo=rust)](https://crates.io/crates/cargo-apk)
[![Documentation](https://docs.rs/cargo-apk/badge.svg)](https://docs.rs/cargo-apk)
[![Lines of code](https://tokei.rs/b1/github/rust-mobile/cargo-apk)](https://github.com/rust-mobile/cargo-apk)
![MIT](https://img.shields.io/badge/License-MIT-green.svg)
![Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-green.svg)

> **Warning**
> This tool is deprecated in favour of [`xbuild`](https://github.com/rust-mobile/xbuild).
Tool for creating Android packages.

## Installation
Expand All @@ -13,7 +23,7 @@ $ cargo install cargo-apk
From source:

```console
$ cargo install --path .
$ cargo install --path cargo-apk/
```

## Commands
Expand Down
13 changes: 13 additions & 0 deletions ndk-build/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# `ndk-build`

[![Actions Status](https://github.com/rust-mobile/cargo-apk/actions/workflows/rust.yml/badge.svg)](https://github.com/rust-mobile/cargo-apk/actions)
[![Latest version](https://img.shields.io/crates/v/ndk-build.svg?logo=rust)](https://crates.io/crates/ndk-build)
[![Documentation](https://docs.rs/ndk-build/badge.svg)](https://docs.rs/ndk-build)
[![Lines of code](https://tokei.rs/b1/github/rust-mobile/cargo-apk)](https://github.com/rust-mobile/cargo-apk)
![MIT](https://img.shields.io/badge/License-MIT-green.svg)
![Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-green.svg)

> **Warning**
> This crate and `cargo-apk` are deprecated in favour of [`xbuild`](https://github.com/rust-mobile/xbuild).
Helps [`cargo-apk`](https://crates.io/crates/cargo-apk) cross-compile libraries and package APKs in a generic, reusable Rust crate.

0 comments on commit 558adff

Please sign in to comment.