add licence and readme

This commit is contained in:
Jean-Marie 'Histausse' Mineau 2025-10-24 18:55:45 +02:00
parent 5921f84c11
commit bb808c86b1
Signed by: histausse
GPG key ID: B66AEEDA9B645AD2
6 changed files with 22 additions and 0 deletions

17
README.md Normal file
View file

@ -0,0 +1,17 @@
# Androscalpel
Androscalpel is a rust crate to manipulate Android application bytecode (dalvik).
This developed between 2022 and 2025 by Jean-Marie Mineau for their PhD thesis, and release under the GPLv3 licence with the permission of CentraleSupelec.
# Documentation
The documentation can be generated with `cargo doc`.
It will be generated at `target/doc/androscalpel/index.html`
Right now, the recompilation process is a little complexe, an example can be found [here](./androscalpel/examples/count_ins_and_genapk.rs).
# Note
The Dalvik v41 format (concatenated DEX files) is not currently supported.
Support is planned in the future.