-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* updated README.md * maybe? * test * test * test * test * test * test * oops * improved title * oppsy daisy * updated title again * added contact information * switched to paragraph's * switched to paragraph's * fixxed code block * added java emoji --------- Co-authored-by: SIEA <69807609+DrVosss@users.noreply.github.com>
- Loading branch information
Showing
1 changed file
with
42 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,58 @@ | ||
| # Kitsune | ||
| <div align='center'> | ||
|
|
||
| # Introduction | ||
| Kitsune is a program that allows one to easily reverse engineer or analyze a limited set of languages. | ||
| Java 17 or higher must be installed. | ||
| <h1>Kitsune</h1> | ||
| <p>Kitsune is a program that allows one to easily reverse engineer or analyze a limited set of languages.</p> | ||
|
|
||
| # Supported Languages | ||
| <p>Created and maintained by <a href="https://github.com/OpticFusion1">OpticFusion1</a>!</p> | ||
|
|
||
| <h4> <a href="https://github.com/OpticFusion1/Kitsune/wiki"> Wiki </a> <span> · </span> <a href="https://github.com/OpticFusion1/Kitsune/issues"> Report Bug </a> <span> · </span> <a href="https://github.com/OpticFusion1/Kitsune/issues"> Request Feature </a> </h4> | ||
| <br> | ||
| <p> ❗ <strong> IMPORTANT!</strong> ☕ Java 17 or higher must be installed. ❗ </p> | ||
| </div> | ||
|
|
||
| ## Supported Languages | ||
| Java, VBScript (Limited Support), and HTML. | ||
|
|
||
| Support for more languages will be added over time. | ||
|
|
||
| # Usage | ||
| All commands can be found in the [wiki](https://github.com/OpticFusion1/Kitsune/wiki) | ||
| ## Usage | ||
|
|
||
| To use Kitsune to its full extent, it's important to know all available commands and when to use them. | ||
|
|
||
| > [!TIP] | ||
| > All commands can be found in the [wiki](https://github.com/OpticFusion1/Kitsune/wiki) | ||
| ## Run | ||
| Download a compiled jar or build it from source and then run it using `java -jar Kitsune.jar` | ||
| The first step to running Kitsune is obtaining a compiled jar. | ||
|
|
||
| You can either download it from [releases](https://github.com/OpticFusion1/Kitsune/releases) or [build](#build) it yourself. | ||
|
|
||
| # Run | ||
| Download a pre-compiled jar or build from source and then run the command `java -jar Kitsune.jar` | ||
| Once you have obtained your Kitsune.jar run it using `java -jar Kitsune.jar` | ||
|
|
||
| # Build | ||
| To build Kitsune from source | ||
| > [!TIP] | ||
| > If you want the latest stable version, I strongly recommend [releases](https://github.com/OpticFusion1/Kitsune/releases) | ||
| ## Build | ||
| #### To build Kitsune from source, run the following commands: | ||
| ``` | ||
| $ git clone git@github.com:OpticFusion1/Kitsune | ||
| $ cd Kitsune/ | ||
| $ mvn clean install | ||
| ``` | ||
|
|
||
| # Example Output | ||
| ## Contact | ||
| Discord · [Optic_Fusion1 Support](https://discord.gg/jMEsq4zHVA) | ||
|
|
||
| Project Link · https://github.com/OpticFusion1/Kitsune/ | ||
|
|
||
| ## Preview | ||
|
|
||
| > [!NOTE] | ||
| > This is a preview output generated using the command `analyze <file>` | ||
|  | ||
|  | ||
|  | ||
|  |