Skip to content

Commit aae2db3

Browse files
author
Your Name
committed
Update README.md with project documentation and usage instructions
1 parent d1c66ae commit aae2db3

1 file changed

Lines changed: 87 additions & 4 deletions

File tree

README.md

Lines changed: 87 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,90 @@
1-
# Tauri + Vanilla TS
1+
# GenEAT GUI
22

3-
This template should help get you started developing with Tauri in vanilla HTML, CSS and Typescript.
3+
A graphical interface for GenEAT - Export Table Hijacking DLL Generator
44

5-
## Recommended IDE Setup
5+
## Project Overview
66

7-
- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
7+
GenEAT GUI is a Tauri-based desktop application that provides a user-friendly interface for the GenEAT tool. It simplifies the process of generating export table hijacking DLLs by providing a graphical interface for selecting files and configuring parameters.
8+
9+
## Features
10+
11+
- **Intuitive GUI**: Easy-to-use interface for generating export table hijacking DLLs
12+
- **File Selection**: Built-in file dialogs for selecting DLL files and output locations
13+
- **Real-time Feedback**: Immediate feedback on generation success or failure
14+
- **Automatic Build**: GitHub Actions workflow for automatic building and release
15+
- **Cross-platform**: Works on Windows, macOS, and Linux
16+
17+
## Installation
18+
19+
### From GitHub Releases
20+
21+
1. Go to the [Releases](https://github.com/yourusername/genEAT-GUI/releases) page
22+
2. Download the latest release for your platform
23+
3. Run the installer or executable
24+
25+
### Building from Source
26+
27+
1. Clone the repository:
28+
```bash
29+
git clone --recursive https://github.com/yourusername/genEAT-GUI.git
30+
cd genEAT-GUI
31+
```
32+
33+
2. Install dependencies:
34+
```bash
35+
npm install
36+
```
37+
38+
3. Build genEAT:
39+
```bash
40+
cd genEAT
41+
mkdir -p build
42+
cd build
43+
cmake ..
44+
cmake --build . --config Release
45+
cd ../..
46+
```
47+
48+
4. Build the Tauri application:
49+
```bash
50+
npm run tauri build
51+
```
52+
53+
## Usage
54+
55+
1. Launch the GenEAT GUI application
56+
2. Click "Browse" next to "DLL File" to select the DLL you want to analyze
57+
3. Click "Browse" next to "Output File" to select where to save the generated C++ file
58+
4. Enter the original DLL name in the "Original DLL Name" field
59+
5. Click the "Generate" button
60+
6. Check the result in the output area
61+
62+
## Project Structure
63+
64+
- `genEAT/` - GenEAT tool submodule (export table hijacking DLL generator)
65+
- `src/` - Frontend code (HTML, CSS, TypeScript)
66+
- `src-tauri/` - Tauri backend code (Rust)
67+
- `.github/workflows/` - GitHub Actions workflow configuration
68+
69+
## GitHub Actions
70+
71+
This project includes a GitHub Actions workflow that automatically builds and releases the application whenever code is pushed to the `master` branch. The workflow:
72+
73+
1. Checks out the code (including submodules)
74+
2. Sets up Node.js environment
75+
3. Installs dependencies
76+
4. Installs Rust toolchain
77+
5. Builds genEAT
78+
6. Builds the Tauri application
79+
7. Creates a GitHub Release
80+
8. Uploads build artifacts
81+
82+
## License
83+
84+
This project is licensed under the MIT License - see the LICENSE file for details.
85+
86+
## Acknowledgments
87+
88+
- [GenEAT](https://github.com/uuvccc/genEAT) - Export Table Hijacking DLL Generator
89+
- [Tauri](https://tauri.app/) - Build smaller, faster, and more secure desktop applications with a web frontend
90+
- [Vite](https://vitejs.dev/) - Next generation frontend tooling

0 commit comments

Comments
 (0)