TREX/qmckl
1
0
Fork 0
mirror of https://github.com/TREX-CoE/qmckl.git synced 2024-12-22 12:23:56 +01:00
Code Issues Projects Releases Wiki Activity

Update README.org

Browse Source
This commit is contained in:
Anthony Scemama 2020-10-14 00:57:25 +02:00 committed by GitHub
parent 6e18f16b82
commit be89fd6fe2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/README.org
View File

@ -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]]