Gitlab is now using https://gitlab.lcsb.uni.lu as it's primary address. Please update your bookmarks. FAQ.

Commit b4b68745 authored by Laurent Heirendt's avatar Laurent Heirendt
Browse files

Merge branch 'develop' into 'master'

Regular merge of develop

See merge request !1
parents d02f5ca7 1020acab
Pipeline #16132 passed with stages
in 41 seconds
# Tenplate for paper
# Template for paper
## Prerequisites
- Install `git`: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
- Install `git-lfs`: https://help.github.com/en/github/managing-large-files/installing-git-large-file-storage
- Install `docker`: https://docs.docker.com/install/
## How to get started
Once all prerequisites have been installed, fork and clone the repository:
```bash
$ git clone ssh://git@git-r3lab-server.uni.lu:8022/<firstname.lastname>/paper.git myPaper
```
Then, create a new branch from the `develop` branch:
```bash
$ cd myPaper
$ git checkout -b myBranch origin/develop
```
## Configure Zotero
In the directory `bib`, copy the `template.ini` file and name it `zotero.ini`:
```bash
$ cp bib/template.ini bib/zotero.ini
```
Then, change the content of the `zotero.ini` file by configuring the `[account]` section:
```
[account]
email = firstname.lastname@domain.com
id = 123456
type = user
key = 1a2b3c4d5e6f7g8h9i0jklmnoprstuvwxyz
```
You can retrieve the data by browsing to https://www.zotero.org/settings/keys. Set the `type` to `group` if you want to access
a group library.
You can either set your email address linked to your Zotero account or your username listed under https://www.zotero.org/settings/account.
## Generate the paper
Once you have configured Zotero, go ahead and generate the paper:
```bash
$ cd myPaper
$ make
```
If you want to view the paper, type within the `myPaper` folder:
```bash
$ make view
```
If you want to recompile the paper from scratch:
```bash
$ make clean
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment