Skip to content

Update README.md #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ cd dts-generator
java -jar build/libs/dts-generator.jar -input <jarFolder>
```

> Note: Check the [Makefile](Makefile) for sample usage

## Generate definitions for .aar
```
Open the .aar archive
Expand Down Expand Up @@ -102,6 +104,7 @@ If you want to generate typings of a package but you are not sure how you can ge
7. Run the dts-generator tool passing as **input** arguments the path to the output jars folder

## Androidx specifics

To get all the jar files for androidx follow the steps above. You can find the **jar** files for androidx 1.0.0 in [the current repository](libs/androidx/1.0.0)
As androidx needs the base android jar file to create its typings you need to pass the android.jar file as a **super** parameter to the generator. To avoid having typings for every different API level you can reuse typings built with API level 17 for all API levels until 23. It's quite easy to test this:

Expand Down