From be89fd6fe2623e350a9a03853de6fc167c0d9df7 Mon Sep 17 00:00:00 2001 From: Anthony Scemama Date: Wed, 14 Oct 2020 00:57:25 +0200 Subject: [PATCH] Update README.org --- src/README.org | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/README.org b/src/README.org index 49abb06..2b3c741 100644 --- a/src/README.org +++ b/src/README.org @@ -1,12 +1,19 @@ -Source files are written in org-mode format, to provide useful comments and -LaTex formulas around the code. +* QMCkl source code -The code is extracted from the org files using Emacs in the `Makefile`, and -then he produced files are compiled. +** Introduction + +Source files are written in org-mode format, to provide useful comments and +LaTex formulas close to the code. There exists multiple possibilities to convert +org-mode files into different formats such as HTML or pdf. + +The code is extracted from the org files using Emacs in the =Makefile=, and +then the produced files are compiled. For a better experience, editing can be done with Emacs. Note that Emacs can behave like Vim when switched into ``Evil'' mode. - +** Documentation + +- [[qmckl_context.c.org][Context]]