update doc

codegrits · Nov 10, 2023 · 924ccb4 · 924ccb4
1 parent 2343b94
commit 924ccb4
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 17 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/API Reference.md b/API Reference.md
@@ -1,13 +1,19 @@
 # Real-time Data API Reference
 
 ## Overview
-We provide a real-time data API for future plug-in developers and researchers to get the real-time data from IDE tracker and eye tracker separately. The API is based on the [IDE Tracker](#ide-tracker) and [Eye Tracker](#eye-tracker).
+We provide a real-time data API for future plugin developers and researchers to get the real-time data from IDE tracker and eye tracker separately. The API is based on the [IDE Tracker](#ide-tracker) and [Eye Tracker](#eye-tracker).
 
 ## Configuration
-add dependency stuff
+Before using the API, you first need to add the following dependency to the `intellij` section in `build.gradle.kts` file.
+
+```groovy
+intellij {
+    plugins.set(file("path-to-CodeGRITS-project\\build\\idea-sandbox\\plugins\\CodeVision"))
+}
+```
 
 ## Quick Start
-describe how to use the API
+To use the API, simply call the `getInstance()` method to get the instance of the IDE Tracker or Eye Tracker. Then, set the `isRealTimeDataTransmitting` to `true` to enable the real-time data transmitting. After that, set the `ideTrackerDataHandler` or `eyeTrackerDataHandler` to handle the real-time data. Finally, call the `startTracking()` method to start tracking.
 
 ```java
 IDETracker ideTracker = IDETracker.getInstance();

diff --git a/DOCUMENT.md → Output Format.md b/DOCUMENT.md → Output Format.md
@@ -1,4 +1,4 @@
-# CodeGRITS Documentation
+# Output Format
 
 ## Output Directory Structure
 
@@ -74,7 +74,8 @@ The [editor coordinate system](https://plugins.jetbrains.com/docs/intellij/coord
     - [`<selection>`](#selection)
   - [`<visible_areas>`](#vis_areas)
     - [`<visible_area>`](#vis_area)
-      :::
+
+:::
 
 ---
 

diff --git a/README.md b/README.md
@@ -1,23 +1,55 @@
-# CodeGRITS
+# Getting Started
 
-## Environment
+## What is CodeGRITS?
+CodeGRITS stands for **G**aze **R**ecording & **I**DE **T**racking **S**ystem, which is a plugin specifically designed for SE researchers. CodeGRITS is
+built on top of IntelliJ’s SDK, with wide compatibility with the
+entire family of JetBrains IDEs to track developers’ IDE interactions and eye gaze data.
+
+## Key Features
+- **Gaze and IDE Recording**: CodeGRITS records developers’ eye gaze data and
+  IDE interactions.
+- **Screen Recording**: CodeGRITS records developers’ screen.
+- **Research Toolkit**: CodeGRITS provides a set of extra features for SE
+  researchers, including preset labels, real-time data API, etc.
+- **Data Export**: CodeGRITS exports data in XML format for further analysis.
+- **Real-time Data API**: CodeGRITS provides real-time data API for further
+  development.
+
+## Using CodeGRITS
+
+### Python Environment
+It is necessary to install the following packages in your python environment to run this plugin.
 
 ```
-Windows 10
-IntelliJ IDEA 2022.1.4
 python==3.8.8
 tobii-research==1.10.1
 pyautogui==0.9.53
 screeninfo==0.8
 ```
 
-## Usage
+### Installation
+1. Clone the [repository](https://github.com/codegrits/CodeGRITS) to your local machine.
+2. Open command line and run `./gradlew build` in the root folder to build the plugin.
+3. Open IntelliJ IDEA and click `File` - `Settings` - `Plugins` - `Install Plugin from Disk...` to install the plugin zip file in `build/distributions` folder.
+4. Restart IntelliJ IDEA to enable the plugin.
+5. All CodeGRITS features are available in `Tools` dropdown menu, including `Start Tracking`, `Pause Tracking`, and `Configuration`.
+
+### Usage
+!!!
+Before starting tracking, you should first configure the plugin. Click `Tools` - `CodeGRITS` - `Configuration` to open the configuration window. To enable eye tracking,
+you need to have the necessary Python packages installed in your Python environment. The plugin automatically checks the Python environment. 
+
+We highly recommend
+using [Tobii Pro Eye Tracker Manager](https://www.tobii.com/products/software/applications-and-developer-kits/tobii-pro-eye-tracker-manager#downloads)
+to conduct calibration before using eye tracking. 
+!!!
 
-You should
-use [Tobii Pro Eye Tracker Manager](https://www.tobii.com/products/software/applications-and-developer-kits/tobii-pro-eye-tracker-manager#downloads)
-to conduct calibration before using this plugin.
+1. Click `Tools` - `CodeGRITS` - `Start Tracking` to start tracking.
+2. Click `Tools` - `CodeGRITS` - `Pause Tracking` to pause tracking.
+3. Click `Tools` - `CodeGRITS` - `Resume Tracking` to resume tracking.
+4. Click `Tools` - `CodeGRITS` - `Stop Tracking` to stop tracking. The plugin will export data in XML format to the configured folder.
 
-## Development
+## Further Development
 
 1. Click `Run` - `Run Plugin` to run the plugin and test it.
 2. Open command line and run `./gradlew build` to build the plugin.