Skip to content

kokkonisd/cs-artifact-template

Repository files navigation

CS artifact template

This is a simple template for an artifact in the form of a Docker image, to accompany a scientific paper. It's tailored for typical Computer Science artifacts, but can potentially serve as a basis for other types of artifacts.

How to use

The artifact template itself can be found in the template/ directory. However, it is made to work as a part of a greater "infrastructure", built around a tool repository and an artifact repository. In order to simultaneously showcase this infrastructure and keep the actual template clean, an example is provided in the example/ directory.

A detailed guide, walking through the example an explaining a real use case, can be found in the documentation. (The Markdown source of the documentation itself can be found in the doc/ directory.)

License

The license found in LICENSE is the Creative Commons Attribution-ShareAlike 4.0 International and applies to all contents of the repo except for the file example/spellcheck-conf99-artifact-repo/wordlists/194434-English-Word-List_djvu.txt.

Credits

The wordlist example/spellcheck-conf99-artifact-repo/wordlists/194434-English-Word-List_djvu.txt comes from https://archive.org/details/194000-english-words-list-compilation/194k-English-words-list/.

About

A template for Computer Science paper artifacts.

Resources

License

Stars

Watchers

Forks

Packages

No packages published