Skip to content

Commit 26f1287

Browse files
SilvioGiancolaSilvioGiancola
committed
improve documentation
1 parent b79e026 commit 26f1287

17 files changed

Lines changed: 107 additions & 88 deletions

‎CONTRIBUTING.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to OSL Action Spotting Annotation Tool
2+
3+
Thank you for considering contributing to this project!
4+
5+
## How to Contribute
6+
7+
1. **Fork the repository**
8+
2. **Create a feature branch** for your changes
9+
3. **Make your changes** (add tests and documentation as needed)
10+
4. **Commit and push** your branch
11+
5. **Open a pull request** describing your changes
12+
13+
## Code Style
14+
- Follow [PEP8](https://www.python.org/dev/peps/pep-0008/) for Python code
15+
- Write clear commit messages
16+
- Add or update documentation as needed
17+
18+
## Reporting Issues
19+
- Use the GitHub Issues page to report bugs or request features
20+
- Please provide as much detail as possible
21+
22+
## Community
23+
- Be respectful and constructive in all interactions
24+
25+
Thank you for helping improve this project!

‎docs/about.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# About
22

3-
The OSL Action Spotting Annotation Tool is developed by [OpenSportsLab](https://github.com/OpenSportsLab), aiming to accelerate research in sports video understanding.
3+
The OSL Action Spotting Annotation Tool is developed by OpenSportsLab to help researchers and practitioners annotate sports video datasets efficiently.
44

55
- **Project Lead:** Silvio Giancola
66
- **GitHub:** [OpenSportsLab/DatasetAnnotationTool](https://github.com/OpenSportsLab/DatasetAnnotationTool)

‎docs/annotating.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# Annotating Actions
22

3-
1. **Play or scrub through the video** to find the action of interest.
4-
2. **Click "Add Annotation"** (or use the shortcut key) when the action starts or ends.
5-
3. **Edit the timestamp or label** directly in the annotation list (right panel).
6-
4. **Repeat** for each action you want to annotate.
3+
Learn how to add, edit, and manage action annotations in your videos.
74

8-
- To change an annotation, select it in the list and edit the timestamp or label.
9-
- To remove an annotation, select and click "Delete".
5+
## Adding Annotations
6+
- Select a video.
7+
- Use the "Add Annotation" button or shortcut.
108

11-
All changes can be saved to an OSL JSON file.
9+
## Editing Annotations
10+
- Select an annotation to edit its label or time.
1211

13-
See [Editing Annotations](editing.md) for advanced editing tips.
12+
See also: [Editing Annotations](editing.md)

‎docs/batch_tools.md‎

Whitespace-only changes.

‎docs/changelog.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented here.
4+
5+
## [Unreleased]
6+
- Initial documentation structure

‎docs/contributing.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Contributing
2+
3+
We welcome contributions! Please:
4+
- Fork the repository
5+
- Create a feature branch
6+
- Submit a pull request
7+
8+
See [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.

‎docs/editing.md‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
# Editing Annotations
22

3-
You can edit any annotation by:
3+
How to modify, move, or delete existing annotations.
44

5-
- Clicking its timestamp to adjust the start/end time
6-
- Editing the action label (e.g., "header", "goal", etc.)
7-
- Deleting annotations you no longer need
8-
9-
Edits are immediately reflected in the annotation list.
10-
Remember to **save** your changes!
11-
12-
---
13-
14-
**Tip:** Use [Keyboard Shortcuts](shortcuts.md) for quick editing.
5+
- Select an annotation from the list.
6+
- Change its label or time.
7+
- Use the remove button to delete.

‎docs/faq.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
# Frequently Asked Questions
1+
# FAQ
22

33
**Q: What video formats are supported?**
4-
A: The tool supports most formats compatible with OpenCV (e.g., mp4, avi).
4+
A: Most common formats (mp4, avi, mkv) supported by PyQt6.
5+
6+
**Q: Can I export my annotations?**
7+
A: Yes, annotations are saved as JSON files.
58

69
**Q: My video doesn't play. What can I do?**
710
A: Check that you have the correct codecs installed and your Python/OpenCV setup is correct. See [Troubleshooting](troubleshooting.md).

‎docs/getting_started.md‎

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,11 @@
11
# Getting Started
22

3-
Once you've [installed](installation.md) the tool, you can start annotating your sports videos:
3+
1. Install the tool (see [Installation](installation.md)).
4+
2. Launch the application.
5+
3. Open or create a new annotation project.
6+
4. Add videos, labels, and start annotating actions.
47

5-
1. **Launch the application:**
6-
```bash
7-
python osl_visualizer/main.py
8-
```
9-
10-
2. **Open a video:**
11-
- Go to **File → Open Video** or use the toolbar button to load your video file.
12-
13-
3. **Load or create an annotation file:**
14-
- To annotate a new video, start adding actions directly.
15-
- To continue annotating, load an existing OSL JSON annotation file.
16-
17-
4. **Begin annotating:**
18-
- Use the playback controls and timeline to navigate your video.
19-
- Click “Add Annotation” to mark an action.
20-
- Edit timestamps and action labels as needed.
21-
22-
5. **Save your work:**
23-
- Save your annotations to an OSL-compatible JSON file via **File → Save Annotations**.
24-
25-
For a full walkthrough, see the [User Guide](gui_overview.md).
8+
See the [User Guide](gui_overview.md) for details on each feature.
269

2710
---
2811

‎docs/gui_overview.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# GUI Overview
22

3+
This page provides an overview of the main interface elements:
4+
- Video player
5+
- Annotation list
6+
- Label management
7+
- Navigation controls
8+
9+
Refer to the screenshots below for a visual guide.
10+
311
The OSL Annotation Tool is organized in three main panels:
412

513
![GUI Layout](assets/screenshot_layout.png)

0 commit comments

Comments
 (0)