mirror of https://gitlab.com/pamhyr/pamhyr2
doc: dev: Complete contribution.
parent
77c0dddee3
commit
a733e148e2
|
|
@ -291,7 +291,7 @@ Some org-mode configuration used in documentations files are define in
|
||||||
- {{{file(setup.el)}}}: GNUEmacs configuration to build documentations
|
- {{{file(setup.el)}}}: GNUEmacs configuration to build documentations
|
||||||
- {{{file(ref.bib)}}}: Bibtex files for documentations files
|
- {{{file(ref.bib)}}}: Bibtex files for documentations files
|
||||||
|
|
||||||
* TODO How to contribute?
|
* How to contribute?
|
||||||
|
|
||||||
Pamhyr2 is free software: you can redistribute it and/or modify it
|
Pamhyr2 is free software: you can redistribute it and/or modify it
|
||||||
under the terms of the GNU General Public License[fn:license], either
|
under the terms of the GNU General Public License[fn:license], either
|
||||||
|
|
@ -339,7 +339,44 @@ information for following contribution.
|
||||||
https://gitlab.irstea.fr/theophile.terraz/pamhyr
|
https://gitlab.irstea.fr/theophile.terraz/pamhyr
|
||||||
[fn:inrae] The INRAE web site: https://www.inrae.fr/
|
[fn:inrae] The INRAE web site: https://www.inrae.fr/
|
||||||
|
|
||||||
** TODO Translate
|
** Translate
|
||||||
** TODO Code contribution
|
|
||||||
|
You can improve or add translation for the project. To contribute to
|
||||||
|
Pamhyr2 translate, you need to use Qt Linguist[fn:qt-linguist]. Open
|
||||||
|
Qt-linguist and edite the translation ({{{file(.ts)}}}) file, finally,
|
||||||
|
commit the new version of file and make a merge request.
|
||||||
|
|
||||||
|
If you want add a new language, edit the script
|
||||||
|
{{{file(src/lang/create_ts.sh)}}} like Listing [[ts-it]]. Run the script
|
||||||
|
and open the new file with Qt-linguist, setup target language (Figure
|
||||||
|
[[qt-linguist-setup]]) and complete translation. Finally, commit the new
|
||||||
|
file and make a merge request.
|
||||||
|
|
||||||
|
#+NAME: ts-it
|
||||||
|
#+CAPTION: Example of modified {{{file(src/lang/create_ts.sh)}}} to add italian (it) translate for Pamhyr2
|
||||||
|
#+begin_src shell
|
||||||
|
...
|
||||||
|
LANG="fr it"
|
||||||
|
...
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
#+NAME: qt-linguist-setup
|
||||||
|
#+ATTR_HTML: :width 8cm
|
||||||
|
#+ATTR_LATEX: :width 8cm
|
||||||
|
#+CAPTION: Qt linguist lang setup example with italian.
|
||||||
|
[[../images/Qt-linguist-setup-lang.png]]
|
||||||
|
|
||||||
|
[fn:qt-linguist] The Qt linguist documentation web page:
|
||||||
|
https://doc.qt.io/qt-5/qtlinguist-index.html (last access 2023-09-18)
|
||||||
|
|
||||||
|
** Code contribution
|
||||||
|
|
||||||
|
If you are developper you can improve and/or add features to
|
||||||
|
Pamhyr2. Please, follow the architecture described in section
|
||||||
|
[[Architecture]] as closely as possible. Keep the code simple, clear and
|
||||||
|
efficient as possible. The master branch is reserved for the project
|
||||||
|
maintainer; you can create a new branch or fork the project before the
|
||||||
|
request.
|
||||||
|
|
||||||
|
|
||||||
{{{biblio}}}
|
{{{biblio}}}
|
||||||
|
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Loading…
Reference in New Issue