Skip to content

Commit 94f3702

Browse files
committed
website update
1 parent 3d50d67 commit 94f3702

File tree

6 files changed

+29
-14
lines changed

6 files changed

+29
-14
lines changed

.github/workflows/retype-action.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@ jobs:
1616

1717
steps:
1818
- uses: actions/checkout@v3
19-
2019
- uses: retypeapp/action-build@latest
21-
2220
- uses: retypeapp/action-github-pages@latest
2321
with:
2422
update-branch: true

.idea/workspace.xml

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

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
1-
# CodeGRITS
1+
# CodeGRITS · [🌐 Visit Website](https://codegrits.github.io/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) [![Star on GitHub](https://img.shields.io/github/stars/codegrits/CodeGRITS?style=social)](https://github.com/codegrits/CodeGRITS)
3+
[![Star on GitHub](https://img.shields.io/github/stars/codegrits/CodeGRITS?style=social)](https://github.com/codegrits/CodeGRITS) [![Paper ACM DL](https://img.shields.io/badge/Paper-ACM%20DL-olive)](https://dl.acm.org/doi/10.1145/3639478.3640037) [![Demo Video](https://img.shields.io/badge/Demo-Video-orange)](https://www.youtube.com/watch?v=d-YsJfW2NMI) [![Javadoc](https://img.shields.io/badge/Javadoc-Docs-blue)](https://codegrits.github.io/CodeGRITS/docs/index.html) [![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)
44

5-
> Enjoying CodeGRITS? Give us a ⭐ to help more developers discover it and support future improvements.
5+
***Enjoying CodeGRITS? Please 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">
99
</p>
1010

11-
The [website](https://codegrits.github.io/CodeGRITS/)'s source code is stored in the `./site` folder of this repository and deployed via GitHub Pages. The [JavaDoc](https://codegrits.github.io/CodeGRITS/docs/index.html) documentation is located in the `./site/docs` folder of this repository. They are archived together with the source code in the Software Heritage for long-term preservation.
12-
13-
The data collected by CodeGRITS can be used by empirical SE researchers to understand the behaviors of developers, especially those related to eye gaze. CodeGRITS also provides a [real-time data API](developer.md) for future plugin developers and researchers to design context-aware programming support tools.
11+
[CodeGRITS](https://codegrits.github.io/CodeGRITS/) stands for **G**aze **R**ecording & **I**DE **T**racking **S**ystem. It's a plugin developed by
12+
the [SaNDwich Lab](https://toby.li/) and is specifically designed for empirical software engineering researchers.
13+
CodeGRITS is built on top
14+
of [IntelliJ Platform SDK](https://plugins.jetbrains.com/docs/intellij/welcome.html), with broad compatibility with the
15+
entire family of JetBrains IDEs and [Tobii eye-tracking devices](https://www.tobii.com/),
16+
to track developers’ IDE interactions and eye gaze data.
1417

15-
We provide an example project [DataStreamReceiver](https://github.com/codegrits/DataStreamReceiver) that builds on top of the real-time data API. It is designed to receive the IDE and eye tracking data and directly visualize them in two separate windows.
18+
The [website](https://codegrits.github.io/CodeGRITS/)'s source code is stored in the `./site` folder of this repository and deployed via GitHub Pages. The [JavaDoc](https://codegrits.github.io/CodeGRITS/docs/index.html) documentation is located in the `./site/docs` folder of this repository. They are archived together with the source code in the Software Heritage for long-term preservation.
1619

1720
## Key Features
1821

@@ -33,9 +36,13 @@ CodeGRITS has been primarily developed and tested on Windows and Linux, with onl
3336

3437
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.
3538

39+
The data collected by CodeGRITS can be used by empirical SE researchers to understand the behaviors of developers, especially those related to eye gaze. CodeGRITS also provides a [real-time data API](developer.md) for future plugin developers and researchers to design context-aware programming support tools.
40+
41+
We provide an example project [DataStreamReceiver](https://github.com/codegrits/DataStreamReceiver) that builds on top of the real-time data API. It is designed to receive the IDE and eye tracking data and directly visualize them in two separate windows.
42+
3643
## Citation
3744

38-
The paper of CodeGRITS has been accepted by [ICSE 2024 Demonstrations Track](https://conf.researchr.org/track/icse-2024/icse-2024-demonstrations). The PDF version is available [here](https://codegrits.github.io/CodeGRITS/static/paper.pdf). The [video demonstration](https://www.youtube.com/watch?v=d-YsJfW2NMI) is available on YouTube.
45+
The [paper](https://dl.acm.org/doi/10.1145/3639478.3640037) of CodeGRITS has been accepted by [ICSE 2024 Demonstrations Track](https://conf.researchr.org/track/icse-2024/icse-2024-demonstrations) with Artifact Available and Artifact Evaluated badges awarded. The PDF version is available [here](https://codegrits.github.io/CodeGRITS/static/paper.pdf). The [video demonstration](https://www.youtube.com/watch?v=d-YsJfW2NMI) is available on YouTube.
3946

4047
Please cite the following if you use CodeGRITS in your research.
4148

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

5259
## Contact us
5360

54-
Please feel free to contact Ningzhi Tang at [email protected]/ningzhitang2[email protected] or Junwen An at [email protected] if you have any questions or suggestions.
61+
Please feel free to contact [Ningzhi Tang](https://www.nztang.com/) at [email protected]/ningzhitang2[email protected] or [Junwen An](https://wanteatfruit.github.io/) at [email protected] if you have any questions or suggestions.

retype.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ branding:
77
logo: static/logo.png
88
label: v0.3.0
99

10+
meta:
11+
title: " | CodeGRITS - JetBrains IDE and Eye Tracking"
12+
description: "CodeGRITS is an open-source plugin for conducting eye-tracking studies in JetBrains IDEs (IntelliJ, PyCharm, etc.), built for empirical software engineering research."
13+
1014
links:
1115
- text: GitHub
1216
link: https://github.com/codegrits/CodeGRITS

site/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ HCI and SE researchers from [SaNDwich Lab](https://toby.li/) at the [University
1010
and [Vanderbilt University](https://www.vanderbilt.edu/).
1111
We are committed to keeping CodeGRITS open source and making it beneficial for the community.
1212

13-
The authors of CodeGRITS are [Ningzhi Tang](https://nztang.com/) (equal contribution),
13+
The authors of CodeGRITS are [Ningzhi Tang](https://www.nztang.com/) (equal contribution),
1414
[Junwen An](https://wanteatfruit.github.io/) (equal contribution),
1515
[Meng Chen](https://casardo-chen.github.io/), [Aakash Bansal](https://aakashba.github.io/),
1616
[Yu Huang](https://yuhuang-lab.github.io/), [Collin McMillan](https://sdf.org/~cmc/),

site/welcome.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
label: Welcome
33
icon: home
44
order: 100
5+
meta:
6+
title: "CodeGRITS - JetBrains IDE and Eye Tracking"
57
---
68

79
# Welcome to CodeGRITS

0 commit comments

Comments
 (0)