updates

Author: CodeMarco05

.gitignore

@@ -66,3 +66,25 @@
 /src-tauri/config
 /config
 app.log
+
+# Ignore test data
+/src-tauri/test-data*/
+
+
+# for the latex stuff
+/FileExplorerAusarbeitung/*.acn
+/FileExplorerAusarbeitung/*.acr
+/FileExplorerAusarbeitung/*.alg
+/FileExplorerAusarbeitung/*.aux
+/FileExplorerAusarbeitung/*.bcf
+/FileExplorerAusarbeitung/*.fdb_latexmk
+/FileExplorerAusarbeitung/*.fls
+/FileExplorerAusarbeitung/*.glg
+/FileExplorerAusarbeitung/*.glo
+/FileExplorerAusarbeitung/*.gls
+/FileExplorerAusarbeitung/*.ist
+/FileExplorerAusarbeitung/*.lof
+/FileExplorerAusarbeitung/*.log
+/FileExplorerAusarbeitung/*.out
+/FileExplorerAusarbeitung/*.xml
+/FileExplorerAusarbeitung/*.toc

README.md

@@ -1,43 +1,124 @@
-[![Rust](https://github.com/conaticus/FileExplorer/actions/workflows/rust.yml/badge.svg?event=push)](https://github.com/conaticus/FileExplorer/actions/workflows/rust.yml)
+<div align="center">
 
-# Fast File Explorer
-This is a fast file explorer written in Rust. After testing on my C drive, this file explorer was able to find a file in 280ms. In comparison, Windows took 3 minutes and 45 seconds.
+# 🚀 Fast File Explorer
 
-Before contributing please read the [contributing guidelines](CONTRIBUTING.md).
+<a href="https://www.rust-lang.org/">
+  <img src="resources/rust-logo.png" alt="Rust Logo" width="80"/>
+</a>
 
-## Supported operating systems
-- Windows
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-There are some issues with Linux and Mac but we shall work on these soon.
+**A fast file explorer built with Rust and Tauri**
 
-Bear in mind this is still in development and missing the following core features:
-- Caching service (constant file watching to keep cache up to date) - only works when program is open
-- Top navigation bar
-- Search/caching progress counter
-- Ability to search for file extensions without including any name
-- Ability to copy/cut/paste files
-- Ability to move files
-- Ability to create files
+<img src="./resources/screenshot-explorer.png" alt="Fast Search Feature" width="700px"/>
 
-![Fast Search Feature](./screenshots/search.jpg)
+</div>
 
-# Dev Setup/Installation
-## Prerequisites
-- Stable [NodeJS](https://nodejs.org/) Install
-- Stable [Rust](https://www.rust-lang.org/) Install
-- Yarn installation (`npm i -g yarn`)
+## 🔍 Current Status
 
-## Steps
+Cross platform compatibility is given and it supports all common Linux distros, which are supported by Tauri. If there is an
+interest of contributing feel free to join the [discord channel](https://discord.com/invite/dnVJQtNXjr) from Connaticus.
+
+## Coming Soon
+
+- Caching service with real-time file watching
+- Search/caching progress indicator
+- A better terminal emulator (maybe it is possible to have the systems default terminal integrated)
+
+# 🛠️ Installation
+
+For the installation there are packages provided with the current stable version. If there are no packages for your system you can
+compile the Explorer from source with the given instructions.
+
+## Installation from source
+
+### Prerequisites for installing from source
+
+- [NodeJS](https://nodejs.org/) (stable version)
+- [Rust](https://www.rust-lang.org/) (stable version)
+
+### Install with compiling from source
+
+Note that on macOS you need XCode installed with the build tools.
+
+```bash
+# Install Tauri CLI
+cargo install tauri-cli # The version should be >2.4.0
+
+# Build for production
+cargo tauri build
+```
+
+After that you need to follow the instructions for your operating system because now the installer for your system is created and
+you need to install the application.
+
+### 🐧 Linux
+
+Under Linux the given command generates an `.deb`, `.rpm`, `AppImage` in the `FileExplorer/src-tauri/target/release/bundle`
+folder. From there on open the file and drag it into the applications folder. Then it should be available.
+
+#### For the `AppImage`
+
+```bash
+#Make sure the image is runnable
+chmod +x yourapp-x.y.z.AppImage
+#Run the image. After that it should behaving like a native application
+./yourapp-x.y.z.AppImage
 ```
-#  Make sure you have Tauri CLI installed
-cargo install tauri-cli
 
-# Install dependencies
-yarn
+### 🍎 macOS
+
+Tauri creates an `.dmg` or `.app` bundle under the folder `FileExplorer/src-tauri/target/release/bundle/macos/`. Open the 
+
+### 🪟 Windows
+
+This generates an installer for your system, which lays in `FileExplorer/src-tauri/target/release/bundle/msi/`. There should be an
+`.exe` or `.msi` which is called `file-explorer`. To install it you need to double click the file and install like any other
+application. Then you can completely remove the `FileExplorer` folder.
+
+### Development Setup
 
-# Run app for development
+```bash
+# Install Tauri CLI
+cargo install tauri-cli # The version should be >2.4.0
+
+# Run in development mode
 cargo tauri dev
 
 # Build for production
 cargo tauri build
 ```
+
+## 📄 History
+
+The Explorer was started as a project from the youtuber [Connaticus](https://www.youtube.com/@conaticus).
+He documented parts of his development journey online in two Videos:
+[I Made a FAST File Explorer](https://youtu.be/Z60f2g-COJY?si=PHWogkV1R_wD8dza)
+and
+[How I RUINED My Rust Project](https://youtu.be/4wdAZQROc4A?si=9ksfN2TcxdDI41BD).
+
+Lots of changes were made in the course of the InformatiCup from the year 2025. It is a competition in Germany. The given task was
+to contribute to existing open source projects. The team members were
+[Marco Brandt](https://github.com/CodeMarco05), [Daniel Schatz](https://github.com/xd1i0), [Lauritz
+Wiebusch](https://github.com/wielauritz), [Sören Panten](https://github.com/SPKonig).
+The repo can be found under [FileExplorer](https://github.com/CodeMarco05/FileExplorer).
+
+## ⚡ Performance
+
+Our benchmarks show extraordinary performance improvements over native solutions:
+
+| Operation   | Fast File Explorer | Windows Explorer |
+| ----------- | :----------------: | :--------------: |
+| File search |       280ms        |    3min 45sec    |
+
+## 🤝 Contributing
+
+Contributions are welcome! Before contributing, please read our [contributing guidelines](CONTRIBUTING.md).
+
+## 📝 License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## 📬 Contact
+
+Have questions or feedback? Open an issue on our GitHub repository!