Skip to content

Commit

Permalink
Update markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
Col-E committed Mar 14, 2020
1 parent 5084c04 commit 017c3bf
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,20 @@ about: Create a report to notify developers of unintended behavior
> A clear and concise description of what the bug is.
**To Reproduce**

Steps to reproduce the behavior:
1. Open sample '...' _(provide sample download if possible)_
2. Navigate to '....'
3. Do something '....'
4. See error

**Exception**

If applicable, add the exception/stacktrace.
```
stacktrace goes here
```

**Screenshots**

If applicable, add screenshots to help explain your problem.
9 changes: 1 addition & 8 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,4 @@ about: Suggest a feature to improve Recaf

## Feature_Name

Short description of the feature

***

**Extra details**:

* More verbose details of features

Description of the feature
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
# Recaf [![Discord](https://img.shields.io/discord/443258489146572810.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/Bya5HaA) [![Build Status](https://travis-ci.org/Col-E/Recaf.svg?branch=master)](https://travis-ci.org/Col-E/Recaf) ![downloads](https://img.shields.io/github/downloads/Col-E/Recaf/total.svg) [![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](CONTRIBUTING.md)

An easy to use modern Java bytecode editor that abstracts away the complexities of Java programs.
Recaf will automatically handle generation of stack frames and constant pool entries for you.
Recaf will automatically handle generation of stack frames and constant pool entries for you.

![screenshot of recaf](docs/screenshots/main.png)

## Preface

If you're just getting started with reverse-engineering in Java, read [PRIMER.md](PRIMER.md).

Documentation for `2.0.0` is on hold until `redesign` is merged into `master`.
In the meantime check out [some usage posts on the blog](https://coley.software/category/recaf/).

## Getting Started

Clone the repository via `git clone -b redesign https://github.com/Col-E/Recaf.git`.
For a quick rundown on how Recaf's functionality, check out the [test classes](src/test/java/me/coley/recaf).
Clone the repository via `git clone -b redesign https://github.com/Col-E/Recaf.git`

Open the project in an IDE or generate the build with maven.

**IDE**:
1. Import the project from the `pom.xml`
* [IntelliJ](https://www.jetbrains.com/help/idea/maven-support.html#maven_import_project_start)
* [Eclipse](https://stackoverflow.com/a/36242422)
2. Create a run configuration with the main class `me.coley.recaf.Recaf`

**Maven**:
1. Execute `mvn clean package`
* You can add `-Dmaven.test.skip` and `-Dcheckstyle.skip` for a faster build time
2. Run the generated build: `java -jar target/recaf-{version}-jar-with-dependencies.jar`

For additional information, join the [Discord](https://discord.gg/Bya5HaA) server.
For additional information, join the [Discord server _(https://discord.gg/Bya5HaA)_](https://discord.gg/Bya5HaA) and check the [blog post on getting started](https://coley.software/recaf-getting-started-primer/).

## Contributing

Expand Down
Binary file added docs/screenshots/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 017c3bf

Please sign in to comment.