Skip to content

Commit a12ee6c

Browse files
author
Sunneva
committed
all files
1 parent 35ed8c4 commit a12ee6c

File tree

2 files changed

+112
-0
lines changed

2 files changed

+112
-0
lines changed

readme_template.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Template README.md
2+
```
3+
# Title
4+
Project description as a paragraph or so explaining what this project does and perhaps why.
5+
6+
# Table of Contents
7+
[Easy to use TOC generator](https://ecotrust-canada.github.io/markdown-toc/)
8+
9+
# Installation
10+
11+
* software requirements
12+
* dependencies
13+
14+
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.
15+
16+
# Running
17+
How to run the program/application/model and common use-cases and outputs.
18+
For the program to be easily usable this section can be quite long.
19+
Make sure to include explenations for all coding examples since it makes them much more understandable.
20+
21+
## API reference (Optional)
22+
If lengthy, this should be a separate document placed as HTML into the `docs/` folder. For more inforation see `documentation`
23+
24+
# License
25+
Mention which LICENSE the code uses and refer to the LICENSE file. For more information about licensing later.
26+
27+
# Authors/Credit
28+
Reykjavik University
29+
30+
Main authors <email.addresses>
31+
32+
## Acknowledgements
33+
If the funding is from a public grant, mention the source of the funding and link to their website.
34+
35+
"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."
36+
37+
# Contributing (Optional)
38+
Explain how people can contribute to this repository. This can also link to a separate Developer reference (Contributing.md)
39+
40+
* how to contribute
41+
* creating issues
42+
* where to get data
43+
* testing
44+
45+
## Description of folder structure (Optional)
46+
47+
# Changelog/Versions (Optional)
48+
# Papers/References (Optional)
49+
50+
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.
51+
```

workflow_example.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Example of a workflow:
2+
```
3+
name: LVL_CI_example
4+
5+
# on controls when this specific action will run.
6+
on:
7+
# The event/s you want to trigger this action
8+
[push, pull_request]:
9+
# Which branch/es the action will run on
10+
branches: [ master ]
11+
12+
#job defines a sequence of tasks that will run when this workflow is triggered.
13+
job:
14+
# A unique id for a job containing only _ or letters, this one is called build
15+
build:
16+
# Specifies which kind of machine the job is run on.
17+
# It's up to you which machine to use but github hosted runners are highly encouraged.
18+
runs-on: ubuntu-latest
19+
20+
#steps defines a tasks to run as part of the job, the following steps
21+
steps:
22+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
23+
- uses: actions/checkout@v2
24+
25+
#--build project--
26+
27+
## Below are some examples of how to run code
28+
29+
- name: example 1
30+
run: echo run can run scripts
31+
32+
- name: example 2
33+
run: |
34+
echo it can also run
35+
echo multi-line scripts
36+
37+
# this example uses a code from another file
38+
- name: example 3
39+
uses: ./.github/actions/my-action
40+
41+
42+
43+
test:
44+
runs-on: ubuntu-latest
45+
46+
steps:
47+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
48+
- uses: actions/checkout@v2
49+
50+
#--run your tests--
51+
52+
package:
53+
runs-on: ubuntu-latest
54+
55+
steps:
56+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
57+
- uses: actions/checkout@v2
58+
59+
#--run your packaging steps--
60+
61+
```

0 commit comments

Comments
 (0)