doc: Add user and developers documentation scheme.

This commit is contained in:
Pierre-Antoine Rouby committed 2023-09-08 17:41:40 +02:00
1 parent 0a968e2184
commit ae857a098a
12 files changed
+283

No files matched your search

+10
View File
@@ -0,0 +1,10 @@
#! /bin/sh
# Build the PDF
emacs -Q -q -nw --batch \
--eval "(require 'org)" \
--eval "(require 'ox-latex)" \
--eval "(load-file \"../tools/setup.el\")" \
--file ./documentation.org \
-f org-latex-export-to-pdf
+1
View File
@@ -0,0 +1 @@
../tools/ref.bib
+55
View File
@@ -0,0 +1,55 @@
# documentation.org -- Pamhyr developers documentation
# Copyright (C) 2023 INRAE
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# -*- coding: utf-8 -*-
#+STARTUP: indent
#+INCLUDE: ../tools/macro.org
#+INCLUDE: ../tools/latex.org
#+TITLE: Developers documentation
#+SUBTITLE: Version: {{{version}}}
#+AUTHOR: {{{INRAE}}}
#+OPTIONS: toc:t
#+LANGUAGE: UKenglish
* TODO The environment
* TODO Architecture
** TODO Model
** TODO Solver
** TODO View
** TODO Unit tests
** TODO The debug mode
* TODO Build the project
** TODO Building packages
*** TODO Linux
*** TODO Windows
* TODO Documentation files
** TODO The environment
** TODO Org-mode
*** TODO Format
*** TODO Macro
*** TODO Footnote
*** TODO References
*** TODO Export
* TODO How to contribute?
** TODO Contribution rules
** TODO Translate
** TODO Code contribution
{{{biblio}}}