Skip to content

Commit f276d84

Browse files
add readme (#4)
1 parent 5363033 commit f276d84

2 files changed

Lines changed: 75 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Taskmon
2+
3+
Taskmon is a lightweight and fast task manager alternative for Windows. It provides a clean interface for monitoring system resources, managing running processes, viewing active tasks, and controlling system performance without unnecessary overhead.
4+
5+
## Documentation
6+
7+
For a comprehensive user guide, including a full list of features and hotkeys, please see the [User Manual](doc/readme.md).
8+
9+
## Prerequisites
10+
11+
To compile Taskmon from source, you need to have the following tools installed on your system:
12+
13+
* Visual Studio Build Tools with C support.
14+
* Windows SDK.
15+
* CMake, version 3.20 or higher. Make sure CMake is in your system path.
16+
17+
## Building
18+
19+
Once the dependencies are installed, you can build the application by running the following commands in the repository root:
20+
21+
```batch
22+
mkdir build
23+
cd build
24+
cmake ..
25+
cmake --build . --config Release
26+
```
27+
28+
When the build is finished, the executable will be located in the build\Release directory.
29+
30+
## License
31+
32+
This project is licensed under the MIT License.

doc/readme.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Taskmon User Manual
2+
3+
Welcome to the Taskmon user manual. Taskmon is designed to be a fast and keyboard-friendly alternative to the standard Windows Task Manager.
4+
5+
## Core Features
6+
7+
* View all running processes and sort them by various resource usage metrics.
8+
* Choose from a large variety of customizable columns to display, including PID, CPU, Memory, Threads, Handles, Command Line, Disk I/O, and many more.
9+
* Minimize to the system tray to keep your taskbar clean.
10+
* Hover over the system tray icon to quickly view CPU and memory usage.
11+
* Suspend, resume, or terminate processes directly from the list.
12+
* Change the priority class of any running process.
13+
* Launch new tasks directly from the application.
14+
* Keep Taskmon Always on Top via the View menu.
15+
* Configurable auto-refresh interval (Off, 5 seconds, 10 seconds, 30 seconds, 1 minute).
16+
* Remembers your window size, position, and column preferences across sessions.
17+
* Option to disable the end task confirmation prompt for faster workflow.
18+
19+
## Column Reordering and Accessible Sorting
20+
21+
Taskmon has robust support for customizing how data is displayed, built specifically with accessibility in mind.
22+
23+
* Drag and drop: You can drag and drop column headers with the mouse to reorder them to your liking.
24+
* Accessible sorting: Screen reader users can press Shift+Tab from the process list to focus a specialized set of hidden radio buttons. From there, use the Left and Right arrow keys to instantly change which column the list is sorted by. Pressing Enter will toggle the sort order between ascending and descending.
25+
26+
## Keyboard Shortcuts
27+
28+
Taskmon supports the following keyboard shortcuts for quick navigation and control:
29+
30+
* Ctrl+Shift+~: Global hotkey to toggle Taskmon visibility from anywhere.
31+
* F5: Refresh the process list manually.
32+
* Ctrl+N: Open the Run dialog to start a new task.
33+
* Ctrl+,: Open the Settings dialog to customize columns and refresh rates.
34+
* Delete: End the currently selected task.
35+
36+
## Context Menu Actions
37+
38+
Bringing up the context menu on a process in the list provides access to several actions:
39+
40+
* Open file location: Opens Windows Explorer to the directory containing the executable.
41+
* Suspend or Resume: Pauses or resumes the execution of the process.
42+
* End task: Forcefully terminates the process.
43+
* Priority: Allows changing the CPU priority class (Idle, Below Normal, Normal, Above Normal, High, Realtime).

0 commit comments

Comments
 (0)