README.md 1.28 KB
Newer Older
Sindre's avatar
Sindre committed
1
2
# TDT4102 Resources repo

3
4
5
6
7
8
9
10
## Setup

The [cppc2020 github repo](https://github.com/LasseNatvig/cppc2020) is a submodule.
To clone this repo including the submodule, use:
```
git clone --recursive https://gitlab.stud.idi.ntnu.no/tdt4102/vs-code/resources.git
```

Trygve Ruud's avatar
Trygve Ruud committed
11
There's no need to update the cppc2020 or exercise handout repos manually as the `release.py` script pulls the latest changes when run.
12
13


Sindre's avatar
Sindre committed
14
Install requirements using pip and the requirements.txt file.
15
16

```
Rune Sætre's avatar
Rune Sætre committed
17
pip install -r requirements.txt
18
19
20
21
22
23
```

## Running
```
python release.py
```
24
## Walkthrough: Adding articles to infobank
Trygve Ruud's avatar
Trygve Ruud committed
25
### Prereqesit
26
It is assumed you have a pdf-file or html-file ready for publishing and that you have added the file to `infobank/Articles/` on gitlab.
Trygve Ruud's avatar
Trygve Ruud committed
27
To se how you can create an html file you open the file at `common\handout\tdt4102\resource-bank\HTML examples\readMe.html` by copying the path and pasting it in to web browser.
Trygve Ruud's avatar
Trygve Ruud committed
28
### Publishing
Trygve Ruud's avatar
Trygve Ruud committed
29
First you run `release.py`:
Trygve Ruud's avatar
Trygve Ruud committed
30
31
32
33
```
python release.py
```
and select `Update all handout files` by using the arrow keys and the return key.
34
This will ensure you only uppdate the handout files, which includes infobank.
Trygve Ruud's avatar
Trygve Ruud committed
35
Continue by describing the changes made in the release.
36
Make sure all changes are committed and `git push`.
Rune Sætre's avatar
Rune Sætre committed
37
You have now hopefully successfully published your articles.