gardener, Interface administrators, Administrators
1,540
edits
Changes
Jump to navigation
Jump to search
* On the top level there should be a LICENSE file containing the text of an open source license of your choice.
fix some details
mtxrun --script install-modules --list
mtxrun --script install-modules --install filter simpleslides
mtxrun --script install-modules --install --all
If you list single modules to install, leave out the prefix (t-* or whatever)!
Previously, the ConTeXt LMTX distribution did not provide a built-in way to install or update modules.
==Module requirements==
While a module usually consists of one main file with a name like <tt>t-modulename.[tex|ctx|mkiv|mkxl]</tt>, there can be many more files, and there should be some documentation. Please adhere to the filename convention conventions outlined in [#Usage].
Sort these files into folders according to TDS (TeX directory structure) – just have a look at the distribution to understand what goes where.
* The filename should be <code>t-modulename-version.zip</code>, where the version is usually a date like <tt>YYYY.MM.DD</tt> (but that’s up to you).
* On the top level there must be a VERSION file that only contains your version string.
* On the top level there should be a README(|.md|.txt) file with some metadata like a short description and author info.
* On the top level there can be a LICENSE file containing the text of an open source license of your choice, if the license is not included in the README.* On the top level there must NOT be a folder with the module name, but only TDS folders like "doc" and "tex".
The same applies for git/SVN repositories containing ConTeXt modules.
VERSION and README files are important for publication on [[https://ctan.org CTAN]]. README is also displayed on git platforms like GitHub or Codeberg and should contain basic documentation. All top level files are ignored by the LMTX module installer.
=== Module main file ===
