Skip to content

docs: add README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@


# Anti-Data Recovery

## Overview
Anti-Data Recovery is an Android application designed to help prevent data recovery of sensitive files. By generating customizable dummy files and directories, the app fills and overwrites storage space to make data recovery significantly more difficult. All generated content is safely stored in the `storage/AntiDataRecovery` directory and can be quickly cleaned up when no longer needed.

## Features
- Generate dummy image (`.png`) or folder/archive (`.zip`) files
- Adjustable target size/amount via an interactive `SeekBar`
- One-tap cleanup to delete all generated files
- System notification alerts upon task completion
- Clean, material-design inspired UI with custom typography (Calligraphy)

## Installation
This is a standard Android Studio project using Gradle. To build and run it locally:

1. Clone the repository:
```bash
git clone https://github.com/amrhossamdev/AntiDataRecovery.git
```
2. Open the project in Android Studio.
3. Allow Gradle to sync and download dependencies.
4. Connect a physical Android device or launch an emulator (API 21+ recommended).
5. Click **Run** (`Shift + F10`) to build and install the app.

## Usage
1. Launch the application and grant the requested storage permissions.
2. Drag the slider to set your desired target amount (displayed in MB).
3. Tap **Images** to generate dummy PNG files, or tap **Folders** to generate dummy ZIP files.
4. The app will run in the background. You'll receive a system notification once the task is complete.
5. Tap **Delete** at any time to remove all generated files from the `AntiDataRecovery` directory.

## Permissions
The app requires the following Android permissions to operate:
- `READ_EXTERNAL_STORAGE` & `WRITE_EXTERNAL_STORAGE`: To create, manage, and delete files on your device's shared storage.
- `INTERNET` & `ACCESS_NETWORK_STATE`: For connectivity checks and potential update/rating functionality.

## Credits
Developed by **Amr Hossam | NanosX Developments**.
Built with Java, Android SDK, AppCompat/Support Libraries, Calligraphy, and Apache Commons IO.