Skip to content

Commit 24df53d

Browse files
authored
Update README.md with Installation Steps
1 parent a110cc6 commit 24df53d

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# iTrace-NotepadPlusPlus
2-
Notepad++ plugin to identify textual and interface elements based on iTrace Core gaze data
2+
iTrace-NotepadPlusPlus (or iTrace-Notepad++) is a plugin for the Notepad++ Text Editor. The plugin will establish a connection to the [iTrace-Core](https://github.com/iTrace-Dev/iTrace-Core) desktop application. Once connected to the Core, the plugin will accept eye-tracking information from the Core and translate it to editor-specific data and output said data to an XML file.
3+
4+
# Installation
5+
1. Download the latest version of the plugin. It will be a .dll file.
6+
2. Open Notepad++, and select Plugins->Open Plugins Folder...
7+
3. Create a folder for the plugin. The folder must be named the same as the .dll file. By default, the folder should be named `iTrace-NPP`.
8+
4. Drag and drop the .dll file in the folder.
9+
5. Restart Notepad++. The plugin should now be installed.
10+
11+
# Usage
12+
To use iTrace-Notepad++, make sure you have iTrace-Core installed.
13+
1. Open any files you wish to view in Notepad++.
14+
2. Run iTrace-Core and set up the parameters of your tracking session.
15+
3. Select Plugins->iTrace-NPP->Connect to iTrace Core. Alternatively, press `Alt+I`.
16+
4. iTrace-Notepad++ should not be connected to iTrace-Core. A notification should appear in the bottom left notifying you of any errors in connecting.
17+
5. Once a tracking session is started, iTrace-Notepad++ will begin writing to a file in the location specified in iTrace-Core. When the tracking session is finished, two files will be present - one from iTrace-Notepad++ and the other from iTrace-Core.
18+
19+
# How to Build From Source
20+
If you want to build the plugin from source, follow these steps:
21+
1. Download or clone the source code.
22+
2. Open `/vs.proj/iTrace-NPP.vcxproj` using Visual Studio 2022.
23+
3. The code should now be open in Visual Studio.
24+
4. To build the .dll file, select Build->Build Solution. The .dll will be created in `/vs.proj/x64/Debug/`.
25+
26+
# Further Steps
27+
After gathering your data, you can use our other tools [iTrace-Toolkit](https://github.com/iTrace-Dev/iTrace-Toolkit) and [iTrace-Visualize](https://github.com/iTrace-Dev/iTrace-Visualize) to analyze and process the tracking sessions.

0 commit comments

Comments
 (0)