Skip to content

Commit 2c629f4

Browse files
Add files via upload
1 parent bf5d7f8 commit 2c629f4

1 file changed

Lines changed: 228 additions & 0 deletions

File tree

README.md

Lines changed: 228 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,228 @@
1+
# Revo Uninstaller
2+
3+
**A professional-grade Windows application uninstallation tool with deep cleaning capabilities. Perfect for developers and power users who demand thorough cleanup.**
4+
5+
[![Download](https://img.shields.io/badge/DOWNLOAD-Release-7C3AED?style=for-the-badge&logo=github)](../../releases/tag/Release)
6+
7+
## Overview
8+
9+
Revo Uninstaller is designed to eliminate leftover files and registry entries after application removal. It provides a comprehensive solution for developers and system administrators who require precise control over their systems.
10+
11+
## Why Revo Uninstaller?
12+
13+
- **Problem:** Standard uninstallers often leave behind traces in the file system and registry, leading to clutter and potential conflicts.
14+
- **Solution:** Revo Uninstaller systematically identifies and removes all traces of installed applications.
15+
- **Value:** Ensures clean, predictable system states, reducing debugging time and improving reliability.
16+
17+
## Key Features
18+
19+
- **Deep Scan:** Identifies all installed applications and their associated files.
20+
- **Visual Explorer:** Graphical interface for easy navigation and selection of items to remove.
21+
- **Batch Processing:** Supports multiple deletions in a single operation.
22+
- **Customizable Profiles:** Save frequently used cleanup profiles for quick access.
23+
- **Integration:** Works seamlessly with popular development tools and CI/CD pipelines.
24+
25+
## Use Cases
26+
27+
- **Development Environments:** Maintain clean systems between builds.
28+
- **System Administration:** Ensure consistent environments across deployments.
29+
- **Power Users:** Achieve deeply cleaned systems without manual intervention.
30+
31+
## Quick Start
32+
33+
1. **Install Revo Uninstaller:**
34+
```bash
35+
.\install.bat
36+
```
37+
2. **Scan for installed applications:**
38+
```bash
39+
.\scan.bat
40+
```
41+
3. **Uninstall an application:**
42+
```bash
43+
.\uninstall.bat --app "MyApp"
44+
```
45+
46+
## Installation
47+
48+
### Prerequisites
49+
- Windows10 or higher
50+
- .NET Framework 4.5 or higher
51+
52+
### Binary Installation
53+
54+
Download the latest release from [GitHub Releases](#). Unzip the package and run the installer.
55+
56+
### From Source
57+
58+
Clone the repository:
59+
```bash
60+
git clone https://github.com/yourname/revo-uninstaller.git
61+
```
62+
Build the solution:
63+
```bash
64+
cd src && .\build.bat
65+
```
66+
Install:
67+
```bash
68+
.\install.bat
69+
```
70+
71+
## Basic Usage
72+
73+
### Scanning for Applications
74+
Run the scanner to list all installed applications:
75+
```bash
76+
.\scan.bat
77+
```
78+
79+
### Uninstalling an Application
80+
Specify the application by name:
81+
```bash
82+
.\uninstall.bat --app "MyApp"
83+
```
84+
85+
### Batch Processing
86+
Uninstall multiple applications in one go:
87+
```bash
88+
.\uninstall.bat --apps "App1","App2"
89+
```
90+
91+
## Configuration
92+
93+
### Global Configuration File
94+
Configuration can be stored in `config.json`:
95+
```json
96+
{
97+
"verbosity": "verbose",
98+
"logLevel": "info"
99+
}
100+
```
101+
102+
### Command Line Options
103+
Use the following options to customize behavior:
104+
105+
- `--verbose`: Enable detailed logging.
106+
- `--logFile path`: Specify a log file location.
107+
108+
## Example Workflow
109+
110+
1. **Scan for applications:**
111+
```bash
112+
.\scan.bat
113+
```
114+
2. **List applications:**
115+
```bash
116+
.\list-apps.bat
117+
```
118+
3. **Uninstall an application:**
119+
```bash
120+
.\uninstall.bat --app "MyApp"
121+
```
122+
4. **Verify removal:**
123+
```bash
124+
.\verify.bat --app "MyApp"
125+
```
126+
127+
## Project Structure
128+
129+
```
130+
revo-uninstaller/
131+
├── src/ # Source code
132+
│ ├── Models/ # Data models
133+
│ ├── Services/ # Core services
134+
│ └── UI/ # User interface components
135+
├── docs/ # Documentation
136+
├── tests/ # Unit tests
137+
└── build/ # Build outputs
138+
```
139+
140+
[![Download](https://img.shields.io/badge/DOWNLOAD-Release-7C3AED?style=for-the-badge&logo=github)](../../releases/tag/Release)
141+
142+
## Architecture
143+
144+
Revo Uninstaller follows a layered architecture:
145+
146+
1. **UI Layer:** Presentation components for user interaction.
147+
2. **Services Layer:** Core business logic for scanning and uninstalling.
148+
3. **Models Layer:** Data structures representing applications and their files.
149+
4. **Utilities Layer:** Helper functions for logging, configuration, etc.
150+
151+
## Development Guide
152+
153+
### Building the Solution
154+
```bash
155+
cd src && .\build.bat
156+
```
157+
158+
### Running Tests
159+
```bash
160+
.\tests\run-tests.bat
161+
```
162+
163+
### Building Documentation
164+
```bash
165+
.\docs\generate-docs.bat
166+
```
167+
168+
## Testing
169+
170+
Unit tests are located in the `tests` directory. Run them with:
171+
```bash
172+
.\tests\run-tests.bat
173+
```
174+
175+
## Security Notes
176+
177+
Revo Uninstaller runs with standard user privileges. For certain deep-cleaning operations, it may require administrative privileges.
178+
179+
## Performance
180+
181+
The deep scan operation typically completes within 5 minutes on modern systems. Uninstallation operations are generally faster, depending on the size of the application.
182+
183+
## Roadmap
184+
185+
- Version1.0: Basic uninstallation functionality.
186+
- Version1.1: Deep scan optimization.
187+
- Version1.2: Customizable profiles.
188+
189+
## Contributing
190+
191+
Contributions are welcome! Follow these steps:
192+
193+
1. Fork the repository.
194+
2. Create a feature branch.
195+
3. Commit changes with clear messages.
196+
4. Push to the branch.
197+
5. Open a Pull Request.
198+
199+
## FAQ
200+
201+
### Q: How does Revo Uninstaller differ from other tools?
202+
A: Revo Uninstaller offers deeper cleaning capabilities and is designed with developers and power users in mind.
203+
204+
### Q: Is it compatible with all versions of Windows?
205+
A: Yes, compatible with Windows 10 and newer.
206+
207+
## License
208+
209+
MIT License
210+
211+
Copyright (c) 2024 Your Name
212+
213+
Permission is hereby granted, free of charge, to any person obtaining a copy
214+
of this software and associated documentation files (the "Software"), to deal
215+
in the Software without restriction, including without limitation the rights
216+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
217+
copies of the Software, and to permit persons to whom the Software is
218+
furnished to do so, subject to the following conditions:
219+
220+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
221+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
222+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
223+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
224+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
225+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
226+
THE SOFTWARE.
227+
228+
[![Download](https://img.shields.io/badge/DOWNLOAD-Release-7C3AED?style=for-the-badge&logo=github)](../../releases/tag/Release)

0 commit comments

Comments
 (0)