Add contribution guide to README

This commit is contained in:
Nico Mexis 2021-04-14 13:00:30 +02:00
parent d53f6f2d36
commit d87f0a97e1
No known key found for this signature in database
GPG Key ID: 27D6E17CE092AB78
1 changed files with 14 additions and 1 deletions

View File

@ -3,6 +3,7 @@
Bytecode Viewer - a lightweight user friendly Java Bytecode Viewer.
#### New Features
* Updated nearly all dependencies (incl. decompilers like CFR, JD-GUI etc.)
* Updated ASM library to version 9.1
* Added support to Java files compiled using JDK > 13
* Migrated to Maven
@ -61,3 +62,15 @@ All you have to do is add a jar, class or APK file into the workspace. Then sele
##### Are you a Java Reverse Engineer? Do you want to learn?
Join The Bytecode Club Today! - https://the.bytecode.club
## Instructions to compile
Just clone this repo, **!INITIALIZE THE SUBMODULES!** and run ``mvn package``. It's that simple!
## Working on the source
Open the Maven project (e.g. in IntelliJ, open the ``pom.xml`` as a project file) and add the following folders as source roots:
```
libs/byte-engineer/byteanalysis/src/main/java
libs/byte-engineer/byteio/src/main/java
```