Skip to content

Commit a9aa8a4

Browse files
authored
Update README.md
1 parent 9f45498 commit a9aa8a4

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# wmw-desktop
2-
What's My Window (WMW) is an utility for reading active application from the OS
2+
What's My Window (WMW) is a simple C++ utility for detecting active application from the OS, designed to display activity in code editors in the Internet.
3+
4+
WMW uses Windows API to get the foreground window and output its name and elapsed time using the following scheme:
5+
```
6+
MyAppName hh:mm:ss
7+
```
8+
9+
where `MyAppName` is the application name and then comes the time.
10+
11+
# Installation
12+
WMW is currently available to use on Windows (though Mac and Linux releases are also planned). The binary is built by pasting the following line into your terminal:
13+
```
14+
g++ .\main.cpp .\processInfo.cpp -o wmw.exe -lpsapi
15+
```
16+
17+
# Configuration
18+
19+
WMW can be widely personalised to the user's needs by changing the values in `settings.hpp`:
20+
21+
`unsigned int interval` - the interval between two window requests in miliseconds (default: `1000`)
22+
23+
`string windowStartup` - the text to display on application startup (used for future translation purposes)
24+
25+
`codeEditors` - a list of key/value pairs of the applications' process names and the corresponding window titles\
26+
(Tip: process names can be obtained via the details tab of the Task Manager)
27+
28+
**Remember**: the settings are stored in the WMW binary and you have to rebuild it to apply the changes!
29+
30+
# To Do
31+
32+
- Add file name/project name detection for the code editors - the window title usually contains them
33+
- Improve the example project by making it refresh automatically every second
34+
- Add the ability to personalise the output structure in the config, e.g. adding the process name or the PID
35+
36+
Feel free to open a pull request if you develop a solution of one of these (new ideas are also welcome)!
37+
38+
39+
# Example
40+
The repository contains an example project using the WMW interface - a basic functionality of HTTP display of the current window.
41+
To open it, install Node.js and NPM and run `npm install` in the `example` folder to download the Node libraries and then `node main.js` to run the app.
42+
Then open [localhost:5500](http://localhost:5500) in your browser and you should see the WMW output!

0 commit comments

Comments
 (0)