Skip to content

Commit 47f7f2a

Browse files
committed
update doc with download links
1 parent 219a63b commit 47f7f2a

File tree

13 files changed

+97
-85
lines changed

13 files changed

+97
-85
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ bin/
3939
.vscode/
4040

4141
### Mac OS ###
42-
.DS_Store
42+
**/.DS_Store

.idea/workspace.xml

Lines changed: 31 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# CodeGRITS
22

3-
[![Website](https://img.shields.io/badge/Website-Visit-brightgreen)](https://codegrits.github.io/CodeGRITS/) [![Javadoc](https://img.shields.io/badge/Javadoc-Docs-blue)](https://codegrits.github.io/CodeGRITS/docs/index.html) [![Paper PDF](https://img.shields.io/badge/Paper-PDF-olive)](https://codegrits.github.io/CodeGRITS/static/paper.pdf) [![Demo Video](https://img.shields.io/badge/Demo-Video-orange)](https://www.youtube.com/watch?v=d-YsJfW2NMI) [![Archived](https://img.shields.io/badge/Archived-SWH-blueviolet)](https://archive.softwareheritage.org/swh:1:dir:32d91426f07dd0f4b36ba05bc708b5a25ad06dd3) [![MIT License](https://img.shields.io/badge/License-MIT-green)](https://github.com/codegrits/CodeGRITS/blob/main/LICENSE)
3+
[![Website](https://img.shields.io/badge/Website-Visit-brightgreen)](https://codegrits.github.io/CodeGRITS/) [![Javadoc](https://img.shields.io/badge/Javadoc-Docs-blue)](https://codegrits.github.io/CodeGRITS/docs/index.html) [![Paper PDF](https://img.shields.io/badge/Paper-PDF-olive)](https://codegrits.github.io/CodeGRITS/static/paper.pdf) [![Demo Video](https://img.shields.io/badge/Demo-Video-orange)](https://www.youtube.com/watch?v=d-YsJfW2NMI) [![Archived](https://img.shields.io/badge/Archived-SWH-blueviolet)](https://archive.softwareheritage.org/swh:1:dir:32d91426f07dd0f4b36ba05bc708b5a25ad06dd3) [![MIT License](https://img.shields.io/badge/License-MIT-green)](https://github.com/codegrits/CodeGRITS/blob/main/LICENSE) [![Star on GitHub](https://img.shields.io/github/stars/codegrits/CodeGRITS?style=social)](https://github.com/codegrits/CodeGRITS)
44

5-
[CodeGRITS](https://codegrits.github.io/CodeGRITS/) stands for **G**aze **R**ecording & **I**DE **T**racking **S**ystem. It's a plugin developed by the [SaNDwich Lab](https://toby.li/) and is specially designed for empirical software engineering researchers. CodeGRITS is built on top of [IntelliJ Platform SDK](https://plugins.jetbrains.com/docs/intellij/welcome.html), with wide compatibility with the entire family of [JetBrains IDEs](https://www.jetbrains.com/) and [Tobii eye-tracking devices](https://www.tobii.com/), to track developers’ IDE interactions and eye gaze data.
5+
> Enjoying CodeGRITS? Give us a ⭐ to help more developers discover it and support future improvements.
66
77
<p align="center">
88
<img src="site/static/overview.png" width="600px" max-width="100%" alt="CodeGRITS Overview">
@@ -31,7 +31,7 @@ CodeGRITS has been primarily developed and tested on Windows and Linux, with onl
3131

3232
## Usage Guide
3333

34-
Please see the [CodeGRITS website](https://codegrits.github.io/CodeGRITS/) for more details. The Javadoc documentation is available [here](https://codegrits.github.io/CodeGRITS/docs/index.html).
34+
Please see the [CodeGRITS website](https://codegrits.github.io/CodeGRITS/) for more details. The Javadoc documentation is available [here](https://codegrits.github.io/CodeGRITS/docs/index.html). Please refer to the [developer guide](https://codegrits.github.io/CodeGRITS/developer/) if you want to contribute to CodeGRITS.
3535

3636
## Citation
3737

@@ -51,4 +51,4 @@ Please cite the following if you use CodeGRITS in your research.
5151

5252
## Contact us
5353

54-
Please feel free to contact Ningzhi Tang at ntang@nd.edu or Junwen An at jan2@nd.edu/feasiblechart@gmail.com if you have any questions or suggestions.
54+
Please feel free to contact Ningzhi Tang at ntang@nd.edu/ningzhitang2001@gmail.com or Junwen An at feasiblechart@gmail.com if you have any questions or suggestions.

gradlew

100644100755
File mode changed.

retype.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ url: https://codegrits.github.io/CodeGRITS/
55
branding:
66
title: CodeGRITS
77
logo: static/logo.png
8-
label: v0.2.0
8+
label: v0.3.0
99

1010
links:
1111
- text: GitHub
@@ -24,6 +24,10 @@ links:
2424
link: https://github.com/codegrits/CodeGRITS/issues
2525
icon: comment-discussion
2626
target: blank
27+
- text: Download
28+
link: https://drive.google.com/file/d/1KF_yehApDJDUrTAU4qzfmt4MeJfsZWcv/view?usp=sharing
29+
icon: download
30+
target: blank
2731

2832
footer:
2933
copyright: © Copyright {{ year }} – [CodeGRITS](https://codegrits.github.io/CodeGRITS/) – All rights reserved

site/about.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ The authors of CodeGRITS are [Ningzhi Tang](https://nztang.com/) (equal contribu
1717
and [Toby Jia-Jun Li](https://toby.li/). Technical support questions, bug reports, and feature requests are best started
1818
as a [GitHub Issue](https://github.com/codegrits/CodeGRITS/issues).
1919

20+
CodeGRITS has won the **Artifact Available** and **Artifact Evaluated** badges at
21+
[ICSE 2024](https://conf.researchr.org/details/icse-2024/icse-2024-artifact-evaluation/49/CodeGRITS-A-Research-Toolkit-for-Developer-Behavior-and-Eye-Tracking-in-IDE)
22+
for its commitment to reproducibility! Please check its details in the [ICSE24-AE](https://github.com/codegrits/ICSE24-AE) repository.
23+
2024
We prepared a video demonstration of CodeGRITS for ICSE 2024.
2125

2226
[!embed](https://www.youtube.com/embed/d-YsJfW2NMI)

site/changelog.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,28 @@ order: 60
99
Encountered a bug or have a suggestion? Please create a [GitHub Issue](https://github.com/codegrits/CodeGRITS/issues).
1010
!!!
1111

12-
## v0.2.0 [!badge text="LATEST" variant="info"]
12+
## v0.3.0 [!badge text="LATEST" variant="info"]
13+
14+
Released on 2025-08-06.
15+
16+
+++ Improved :icon-thumbsup:
17+
- [x] Resolve issues related to the logistics of the configuration file saving location.
18+
+++
19+
20+
## v0.2.0
1321

1422
Released on 2023-12-28.
1523

1624
+++ New :icon-shield-check:
17-
18-
- [x] Improve the implementation of Screen Recorder from [JCodec](http://jcodec.org/index.html)
19-
to [JavaCV](http://bytedeco.org/).
25+
- [x] Improve the implementation of Screen Recorder from [JCodec](http://jcodec.org/index.html) to [JavaCV](http://bytedeco.org/).
2026
- [x] Initial pre-mature release for CodeGRITS.
21-
+++
27+
+++
2228

23-
+++ Improved :icon-thumbsup:
29+
+++ Improved :icon-thumbsup:
2430
- [x] Fix the color distortion and the missing cursor issues of the screen recorder.
2531
- [x] Fix several issues about the naming.
2632
- [x] Add the logo of CodeGRITS.
27-
+++
33+
+++
2834

2935
---
3036

@@ -33,9 +39,8 @@ Released on 2023-12-28.
3339
Released on 2023-11-30.
3440

3541
+++ New :icon-shield-check:
36-
3742
- [x] Release for ICSE 2024 Demo review.
38-
+++
43+
+++
3944

4045
---
4146

site/developer.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,14 @@ order: 70
66

77
# Developer Guide
88

9-
## Further Development
9+
We have provided a [Google Doc](https://docs.google.com/document/d/1_F2sq6U0riRSHU5WK0StQeAnJHSHCKZR9L_EZUeT6RE/edit?usp=sharing) outlining several directions worth exploring for the future development of CodeGRITS.
10+
We encourage the community to contribute to CodeGRITS by submitting GitHub issues and pull requests to develop new features.
11+
Please refer to the document for more details, and feel free to leave comments or suggestions.
1012

11-
Please refer to [IntelliJ Platform SDK](https://plugins.jetbrains.com/docs/intellij/welcome.html) for more details.
13+
For technical details, please refer to [IntelliJ Platform SDK](https://plugins.jetbrains.com/docs/intellij/welcome.html).
1214
We also provide the [JavaDoc](docs/index.html) of the source code.
13-
Feel free to contact us if you need any help.
1415

15-
### Accommodating New IDEs
16-
17-
See [Build from Source](usage.md#build-from-source).
18-
19-
### Accommodating New Eye Trackers
16+
## Supporting New Eye Trackers
2017

2118
If you want to integrate other eye-tracking devices except for Tobii eye-tracking devices, you need to reimplement all
2219
Python scripts in the source code to get the right eye-tracking device information and eye gaze data using your eye
@@ -62,7 +59,7 @@ intellij {
6259
You also need to add the following to `./src/main/resources/META-INF/plugin.xml`.
6360

6461
```xml
65-
<depends>com.nd.codegrits</depends>
62+
<depends>io.github.codegrits</depends>
6663
```
6764

6865
### Quick Start

site/faq.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,17 @@ in the configuration window to disable the eye tracker to only use the IDE track
2424

2525
See [Accommodating New Eye Trackers](developer.md#accommodating-new-eye-trackers).
2626

27-
#### Q4. How to use CodeGRITS in other JetBrains IDEs?
27+
#### Q4. What IDEs can CodeGRITS be used for?
2828

29-
See [Accommodating New IDEs](developer.md#accommodating-new-ides).
29+
CodeGRITS is expected to support the entire family of JetBrains IDEs—including IntelliJ IDEA, PyCharm, WebStorm, and others—
30+
because its implementation is independent of any IDE-specific features.
3031

31-
#### Q5. How efficient is the processing of raw eye gaze data?
32+
#### Q5. How accurate is the mapping of eye gazes to source code?
33+
34+
The mapping itself is 100% accurate, as we leverage internal JetBrains IDE APIs to implement this functionality.
35+
Any inaccuracy is most likely due to the data provided by the eye-tracking device.
36+
37+
#### Q6. How efficient is the processing of raw eye gaze data?
3238

3339
In CodeGRITS, the efficiency of the processing of gaze data is negligible. For each gaze, we calculate the average time
3440
from the timestamp in the raw data to the timestamp after all processing is complete. This processing primarily involves
@@ -39,15 +45,15 @@ short time frame, which ensures the accuracy of gaze processing. Moreover, compa
3945
to [iTrace](https://www.i-trace.org/), our method of receiving data from the
4046
eye-tracking device is more efficient, ensuring that all sampled gazes are mapped without any loss.
4147

42-
#### Q6. How much storage space does CodeGRITS require?
48+
#### Q7. How much storage space does CodeGRITS require?
4349

4450
Generally speaking, a high sample frequency generates a large amount of gaze data. To conserve storage space, we
4551
only perform upward traversal of the AST of the first gaze and record the hierarchy structure, and mark the rest
4652
as `same`. This approach significantly reduces storage space. In a previous debugging study, we set the eye-tracking
4753
device's sample frequency to 60Hz, and during the 20-minute experiment, the eye-tracking data amounted to only about
4854
40MB.
4955

50-
#### Q7. Which eye gazes can be analyzed, and can gazes on the UI be understood?
56+
#### Q8. Which eye gazes can be analyzed, and can gazes on the UI be understood?
5157

5258
In CodeGRITS, we only analyze gazes within the code editor. For example, in the following figure, only gazes within the
5359
red rectangle are mapped to the source code tokens and performed the upward traversal of the AST. For gazes outside the

site/static/paper.pdf

205 KB
Binary file not shown.

0 commit comments

Comments
 (0)