Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the README a bit #35

Merged
merged 2 commits into from
Apr 22, 2024
Merged

Improve the README a bit #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49b9886
Improve README a bit
Ostrzyciel Apr 22, 2024
b815654
docs: changed article url, better tex key
Kaszanas Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

Tools in this repository were used to create the **[SC2ReSet: StarCraft II Esport Replaypack Set](https://doi.org/10.5281/zenodo.5575796)**, and finally **[SC2EGSet: StarCraft II Esport Game State Dataset](https://doi.org/10.5281/zenodo.5503997)**.

# Installation
## Installation

To install current version of the toolset as separate CLI tools run the following command:

```
pip install datasetpreparator[all]
```
Expand Down Expand Up @@ -41,9 +42,15 @@ In order to specify different processing flags for https://github.com/Kaszanas/S

Each of the scripts has its usage described in their respective `README.md` files.

# Citations
## Contributing and Reporting Issues

If you want to report a bug, request a feature, or open any other issue, please do so in the **[issue tracker](https://github.com/Kaszanas/SC2DatasetPreparator/issues/new/choose)**.

Please see **[CONTRIBUTING.md](https://github.com/Kaszanas/SC2DatasetPreparator/blob/main/CONTRIBUTING.md)** for detailed development instructions and contribution guidelines.

## Citing

## This Repository
### This Repository

```
@software{Białecki_2022_6366039,
Expand All @@ -62,10 +69,10 @@ Each of the scripts has its usage described in their respective `README.md` file

```

## [SC2EGSet: Dataset Description](https://arxiv.org/abs/2207.03428)
### [SC2EGSet: Dataset Description](https://www.researchgate.net/publication/373767449_SC2EGSet_StarCraft_II_Esport_Replay_and_Game-state_Dataset)

```
@article{Białecki2023,
@article{Bialecki2023_SC2EGSet,
author = {Bia{\l}ecki, Andrzej
and Jakubowska, Natalia
and Dobrowolski, Pawe{\l}
Expand Down
Loading