Skip to content

Commit f594d70

Browse files
authored
Update README.md
1 parent 63cab48 commit f594d70

File tree

1 file changed

+41
-2
lines changed

1 file changed

+41
-2
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
1-
# Rust-Windows-File-Explorer
2-
This is a file explorer written in Rust optimised for speed in searching.
1+
# Rust Windows File Explorer
2+
A simple file explorer written in Rust using the Druid framework.
3+
4+
## Features
5+
6+
- Search for files by name in the specified directory.
7+
- Displays search results with a case-insensitive regex match for file names.
8+
- User interface powered by the Druid framework.
9+
- Results are shown in a scrollable window.
10+
11+
## Usage
12+
13+
1. Clone the repository:
14+
15+
```bash
16+
git clone https://github.com/CollinEdward/Rust-Windows-File-Explorer.git
17+
```
18+
19+
2. Navigate to the project directory:
20+
21+
```bash
22+
cd Rust-Windows-File-Explorer
23+
```
24+
25+
3. Build and run the application:
26+
27+
```bash
28+
cargo run
29+
```
30+
31+
4. Enter the directory path and search term in the provided text boxes.
32+
5. Click the "Search" button to initiate the search.
33+
34+
## Dependencies
35+
36+
- [Druid](https://github.com/linebender/druid): A data-driven Rust GUI framework.
37+
- [walkdir](https://crates.io/crates/walkdir): A simple filesystem walker.
38+
39+
## License
40+
41+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)