Skip to content

Commit

Permalink
Update README and CHANGELOG.
Browse files Browse the repository at this point in the history
  • Loading branch information
netomi committed Sep 18, 2022
1 parent 5ed1200 commit 9aa14a5
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 10 deletions.
14 changes: 10 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [0.2.0] - unreleased
## [0.2.0] - 2022-09-18

### Added

- java class file assembler / disassembler
-
- class file assembler / disassembler, work in progress
- added support for releases on jitpack.io

### Changed

- finish class dump tool
- completed classfile module
- completed class dump tool

### Removed

- Removed guava dependency

## [0.1.0] - 2022-08-12

Expand Down
40 changes: 34 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ This goal of this project is to provide tools to work with various java related

The following modules are currently available

1. classfile: reads and writes **class** files
2. dexfile: reads and writes **dex** files
3. dexdump: prints the contents of **dex** files in the same format as the _dexdump_ tool
4. classdump: prints the contents of **class** files in the same format as the _javap_ tool
4. smali: assembler/disassembler for **dex** files
5. tools: convenient command line tools for the different modules
* `classfile`: reads and writes **class** files
* `dexfile`: reads and writes **dex** files
* `dexdump`: prints the contents of **dex** files in the same format as the _dexdump_ tool
* `classdump`: prints the contents of **class** files in the same format as the _javap_ tool
* `smali`: assembler/disassembler for **dex** files
* `jasm`: assembler/disassembler for **class** files
* `tools`: convenient command line tools for the different modules

## Usage

Expand Down Expand Up @@ -40,5 +41,32 @@ Options:
> bat-baksmali.sh -v -o out classes.dex
The generated **smali** files will be created in the **out** directory in a directory structure resembling the package name of the disassembled classes.

## Dependency

To use the different modules via e.g. gradle in your own application, you can add the following to your build configuration:

```
repositories {
...
maven("https://jitpack.io")
}
dependencies {
...
implementation("com.github.netomi.bat:<module>:<tag>|<commit>|<release>")
}
```

where **<module>** might be one of

* `classfile`
* `dexfile`
* `classdump`
* `dexdump`
* `smali`
* `jasm`
* `tinydvm`

## License
[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)

0 comments on commit 9aa14a5

Please sign in to comment.