Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update CI Badge
  • Loading branch information
fangohr committed Jun 14, 2024
1 parent fe4fd19 commit b5158dd
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[![Build Status](https://travis-ci.org/fangohr/template-latex-paper-from-orgmode.svg?branch=master)](https://travis-ci.org/fangohr/template-latex-paper-from-orgmode)
[![ci-build-pdf](https://github.com/fangohr/template-latex-paper-from-orgmode/actions/workflows/ci.yml/badge.svg)](https://github.com/fangohr/template-latex-paper-from-orgmode/actions/workflows/ci.yml)

# Template for writing LaTeX documents from Emacs orgmode

A set of (mostly) self-explaining files for using orgmode to author structure and content of a document, and then insert this into a latex template. Use cases are where the latex style, class, and detailed commands to be used are prescribed by the journal/publisher etc.

Requirements: A recent Emacs (tested on Emacs 24.5, and 28.2), Python, make, pdflatex.
Requirements: A recent Emacs (tested on Emacs 24.5, and 28.2), Python, make, pdflatex, latemk for `watch` target.

## Get started

Expand All @@ -14,14 +14,12 @@ Requirements: A recent Emacs (tested on Emacs 24.5, and 28.2), Python, make, pdf

## What does the final ``paper.pdf`` look like?

We have committed this file for convenience to the repository, and it can be seen [here](compiled-paper.pdf).
We have committed this file for convenience to the repository, and it can be seen [here](compiled-paper.pdf), or downloaded as an artifact.

Author: Hans Fangohr, University of Southampton, European XFEL
Author: Hans Fangohr, University of Southampton, European XFEL, MPSD

## Update 2018
## Changes

Note the contribution that shows a one-file solution for this problem at https://github.com/fangohr/template-latex-paper-from-orgmode/issues/4 by @dineshadepu .

## Update 2023

- added target `make watch` to automatically recompile on change of sources
- 2018: Note the contribution that shows a one-file solution for this problem at https://github.com/fangohr/template-latex-paper-from-orgmode/issues/4 by @dineshadepu .
- 2023: added target `make watch` to automatically recompile on change of sources (using `latexmk`)
- 2024: activate Github actions to provide CI

0 comments on commit b5158dd

Please sign in to comment.