Skip to content

Commit 977ca84

Browse files
authored
Update README.md
1 parent 3df0c3e commit 977ca84

File tree

1 file changed

+91
-1
lines changed

1 file changed

+91
-1
lines changed

README.md

Lines changed: 91 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,92 @@
1+
---
2+
13
# DirCrypt
2-
Directory, files Encryptor/Decryptor with custom password.
4+
5+
DirCrypt is a user-friendly tool for encrypting and decrypting directories. It provides a simple graphical interface to secure your files with a password. This application is useful for protecting sensitive data by transforming it into an unreadable format and restoring it when needed.
6+
7+
## Features
8+
9+
- **Encrypt Directories**: Secure your directories with a password to prevent unauthorized access.
10+
- **Decrypt Directories**: Restore encrypted directories back to their original state using the correct password.
11+
- **Simple GUI**: Easy-to-use graphical interface for selecting directories, setting passwords, and starting encryption or decryption.
12+
- **Password Protection**: Password-based encryption to safeguard your data.
13+
- **Cross-Platform**: Works on various versions of Windows, making it accessible to a broad range of users.
14+
15+
## Getting Started
16+
17+
### Prerequisites
18+
19+
- **.NET Framework**: Ensure the .NET Framework is installed on your system. You can download it from [Microsoft's website](https://dotnet.microsoft.com/download/dotnet-framework).
20+
- **Visual Studio**: Install Visual Studio for compiling and running the application. You can download it from [visualstudio.microsoft.com](https://visualstudio.microsoft.com/).
21+
22+
### Installation
23+
24+
1. **Clone the repository**:
25+
```bash
26+
git clone https://github.com/yourusername/dircrypt.git
27+
cd dircrypt
28+
```
29+
30+
2. **Open Project in Visual Studio**:
31+
- Open Visual Studio.
32+
- Select `Open a project or solution`.
33+
- Navigate to the directory where you cloned the repository and open `DirCrypt.sln`.
34+
35+
3. **Build and Run the Application**:
36+
- Click on `Build` in the top menu.
37+
- Select `Build Solution`.
38+
- Click on `Debug` in the top menu and select `Start Debugging` or press `F5` to run the application.
39+
40+
### Usage
41+
42+
1. **Launch DirCrypt**: Start the application by running `DirCrypt.exe` after building it.
43+
44+
2. **Select Directory**: Click the `Select` button and choose the directory you want to encrypt or decrypt.
45+
46+
3. **Enter Password**: Type a password into the password field. This password will be used to secure your directory.
47+
48+
4. **Choose Operation**: Select either `Encryption` or `Decryption` based on your desired action.
49+
50+
5. **Start Process**: Click the `Start encrypting` button to initiate the encryption or decryption process.
51+
52+
### Detailed Steps
53+
54+
#### Encrypting a Directory
55+
56+
1. **Select Directory**: Click `Select` and navigate to the directory you wish to encrypt.
57+
2. **Set Password**: Enter a strong password in the `Password for directory` field.
58+
3. **Choose Encryption**: Ensure the `Encryption` option is selected.
59+
4. **Start Encryption**: Click the `Start encrypting` button. The directory will be encrypted and secured with the chosen password.
60+
61+
#### Decrypting a Directory
62+
63+
1. **Select Directory**: Click `Select` and navigate to the encrypted directory.
64+
2. **Enter Password**: Type the password used during encryption in the `Password for directory` field.
65+
3. **Choose Decryption**: Select the `Decryption` option.
66+
4. **Start Decryption**: Click the `Start encrypting` button to decrypt the directory.
67+
68+
## Screenshots
69+
70+
![DirCrypt Interface](https://i.imgur.com/7r3tD2g.png)
71+
72+
## Contributing
73+
74+
If you'd like to contribute to this project, please fork the repository and use a feature branch. Pull requests are warmly welcome.
75+
76+
1. Fork the repository.
77+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`).
78+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
79+
4. Push to the branch (`git push origin feature/AmazingFeature`).
80+
5. Open a pull request.
81+
82+
## License
83+
84+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
85+
86+
## Contact
87+
88+
For any questions or issues, please contact [eddit@edditdev.com].
89+
90+
---
91+
92+

0 commit comments

Comments
 (0)