Skip to content

Commit e1bd77e

Browse files
committed
update README
1 parent 81dfacc commit e1bd77e

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
[![Build Status](https://github.com/javaLux/traceview/actions/workflows/ci.yml/badge.svg)](https://github.com/javaLux/traceview/actions)
2+
[![dependency status](https://deps.rs/repo/github/javaLux/traceview/status.svg)](https://deps.rs/repo/github/javaLux/traceview)
3+
[![GitHub license](https://img.shields.io/github/license/javaLux/traceview.svg)](https://github.com/javaLux/traceview/blob/main/LICENSE)
4+
[![crates.io](https://img.shields.io/crates/v/traceview.svg)](https://crates.io/crates/traceview)
5+
![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
6+
17
# TraceView
28

39
🚀 **TraceView** is a fast and feature-rich TUI (Text-based User Interface) application written in Rust. It enables users to navigate the local filesystem, monitor system resources, search for files and directories, retrieve metadata, and export search results to JSON. The app is configurable via a `config.toml` file and provides a smooth user experience with different themes.
@@ -21,6 +27,8 @@
2127

2228
---
2329

30+
<br>
31+
2432
## 🚀 Getting Started
2533
### 📦 Installation
2634
There are three ways to get started with TraceView:
@@ -78,6 +86,8 @@ TraceView is available on [crates.io](https://crates.io/crates/traceview), allow
7886
```
7987
---
8088

89+
<br>
90+
8191
## 🎨 Configuration
8292
TraceView is configurable via the `config.toml` file located in the Config-Directory. Below is the structure of the default configuration file:
8393

@@ -126,6 +136,8 @@ traceview -r 2 -f 30 -c "/path/to/custom_config.toml"
126136
```
127137
---
128138

139+
<br>
140+
129141
## 🎨 Themes
130142
Supported themes:
131143
- 🖤 **Dark** – High contrast for low-light environments (default)
@@ -137,6 +149,7 @@ To change the theme you can press `Tab` within the app or if you want to set a d
137149

138150
---
139151

152+
<br>
140153

141154
## App Contexts
142155
TraceView operates in three primary contexts, each with context-specific controls and keybindings:
@@ -148,14 +161,14 @@ TraceView operates in three primary contexts, each with context-specific control
148161
* Please use the provided help page by pressing “F1” to view all keyboard shortcuts and their context.
149162

150163
## 🧮 Status Bar Features
151-
---
152164
The status bar, located at the bottom of the interface, provides:
153165
- 🗂️ **Current Context**: Shows whether you are in Explorer, Search, or Result context.
154166
- 🎨 **Active Theme**: Displays the currently applied theme.
155167
- ⌨️ **Last Keystroke**: Shows the last pressed key.
156168
-**Error Messages**: Displays any application errors or warnings.
157169
---
158170

171+
<br>
159172

160173
## 🔎 Searching by File or Directory Name
161174
TraceView provides a powerful search feature that allows users to search specifically for **file and directory names**. The search functionality focuses only on names, making it possible to:
@@ -168,6 +181,11 @@ TraceView offers two search modes:
168181
- **Flat Search:** 🔎 Searches only within the currently selected directory (non-recursive). Ideal for quick local searches.
169182
- **Deep Search:** 🌐 Recursively searches through all subdirectories within the selected path. Useful for locating files or directories in nested structures.
170183

184+
### 📝 **Search Input History:**
185+
- The input field for typing search queries maintains a **history of previous searches** during the current session.
186+
- Navigate through past queries using the **Up (↑)** and **Down (↓)** arrow keys to quickly reuse or modify previous searches.
187+
- This feature enhances efficiency, especially when refining searches or repeating common queries.
188+
171189
**Usage Notes:**
172190
- Initiate a search by pressing `Ctrl + F` in the Explorer Context.
173191
- Enter your search query and choose between Flat or Deep mode.
@@ -178,6 +196,7 @@ TraceView offers two search modes:
178196
- **Flat Search** provides faster results for localized searches.
179197
---
180198

199+
<br>
181200

182201
## 🗂️ Capturing File and Directory Metadata
183202
TraceView allows users to capture metadata for both files and directories with the following considerations:
@@ -196,6 +215,7 @@ TraceView allows users to capture metadata for both files and directories with t
196215
- If `follow_sym_links` is enabled in the configuration, symbolic links within directories are also traversed, potentially increasing processing time.
197216
---
198217

218+
<br>
199219

200220
## ⏳ If Things Take a Long Time
201221
Some operations in TraceView, such as searching for files/directories or exporting search results, may take longer to complete depending on the size and complexity of the filesystem.
@@ -205,6 +225,7 @@ Some operations in TraceView, such as searching for files/directories or exporti
205225
- This is especially useful during deep searches or large directory exports that require extensive processing time.
206226
---
207227

228+
<br>
208229

209230
## 🚫 Limitations & Future Plans
210231
While TraceView offers a variety of features for browsing, searching, and viewing metadata, it is important to note that **it is not a full-fledged file explorer**. As such:
@@ -213,12 +234,14 @@ While TraceView offers a variety of features for browsing, searching, and viewin
213234
- 📄 TraceView is currently designed to provide safe, read-only access to filesystem information without risking unintended file modifications.
214235
---
215236

237+
<br>
216238

217239
## 🛡️ License
218240
This project is licensed under the MIT License.
219241

220242
---
221243

244+
<br>
222245

223246
## 🧰 Built With ❤️ in Rust and these awesome crates
224247
Thanks to the developers of these crates, without whom `TraceView` would not exist<br>
@@ -227,6 +250,7 @@ Thanks to the developers of these crates, without whom `TraceView` would not exi
227250
- ⌨️ **[Crossterm](https://crates.io/crates/crossterm)** – Cross-platform Terminal Manipulation Library 🖲️
228251
---
229252

253+
<br>
230254

231255
## 🧪 Tested Platforms
232256
TraceView has been tested on the following operating systems and environments with **x86_64** CPU architecture:
@@ -243,6 +267,8 @@ When testing under MacOs, I noticed that the standard terminal does not fully su
243267

244268
---
245269

270+
<br>
271+
246272
## 🛠️ Troubleshooting
247273
### 🪟 **Windows Terminal Freeze Issue**
248274
If you experience the app freezing when clicking inside the terminal window with the **left mouse button** on Windows, this is due to the terminal's default behavior of entering "selection mode." In this mode, terminal input is paused while text is being selected. To avoid this issue:
@@ -259,5 +285,25 @@ If an error appears in the status bar:
259285

260286
---
261287

288+
<br>
289+
290+
## 🤝 **Collaboration, Feedback & Bug Reports**
291+
I welcome feedback, suggestions, and bug reports! Your input helps make TraceView better.
292+
293+
### 💬 **How to Contribute:**
294+
- Report issues or suggestions via [GitHub Issues](https://github.com/javaLux/traceview/issues).
295+
- Submit pull requests to improve the code or documentation.
296+
- Share your thoughts to help shape future features.
297+
298+
### 🐛 **Found a Bug?**
299+
- Check if it’s already reported.
300+
- If new, open an issue with details and reproduction steps.
301+
- Attach logs (in `data` directory) for faster diagnosis.
302+
303+
### 📢 **I Appreciate Your Feedback!**
304+
Your ideas and input make TraceView more user-friendly. Don’t hesitate to reach out.
305+
306+
<br>
307+
262308
## 🚀 Thank you for using TraceView! 🙌
263309

0 commit comments

Comments
 (0)