Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 2 KB

readme_template.md

File metadata and controls

51 lines (35 loc) · 2 KB

Template README.md

# Title 
Project description as a paragraph or so explaining what this project does and perhaps why.

# Table of Contents
[Easy to use TOC generator](https://ecotrust-canada.github.io/markdown-toc/)

# Installation

* software requirements
* dependencies

It is also helpful to provide commands which assist user installing the program or even providing an `install.sh` script which does it for the user.

# Running
How to run the program/application/model and common use-cases and outputs.
For the program to be easily usable this section can be quite long.
Make sure to include explenations for all coding examples since it makes them much more understandable. 

## API reference (Optional)
If lengthy, this should be a separate document placed as HTML into the `docs/` folder. For more inforation see `documentation`

# License
Mention which LICENSE the code uses and refer to the LICENSE file. For more information about licensing later.

# Authors/Credit
Reykjavik University

Main authors <email.addresses>

## Acknowledgements
If the funding is from a public grant, mention the source of the funding and link to their website.

"This project was funded by the Language Technology Programme for Icelandic 2019-2023. The programme, which is managed and coordinated by [Almannarómur](https://almannaromur.is/), is funded by the Icelandic Ministry of Education, Science and Culture."

# Contributing (Optional)
Explain how people can contribute to this repository. This can also link to a separate Developer reference (Contributing.md)

* how to contribute
* creating issues
* where to get data
* testing

## Description of folder structure (Optional)

# Changelog/Versions (Optional)
# Papers/References (Optional)

You would have a citation snippet here as a code block. For papers not yet accepted it is fine to mention you have submitted a paper to a particular conference and mention how you will reference it once has been accepted. For example you could add a citation or include the paper in the docs folder.