blob: 8045a1a21078b5299c5d0ca8a0848c4e90a1d0f8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
codedescribe / codelisting
==========
These are expl3 based packages for LaTeX/expl3 code documetation.
### codedescribe
provides a series of macros/environments (similar to doc/docx/doc3) for package/classes documentantion
### codelisting
provides a few macros for LaTeX code listing/demo.
They are designed to be 'as class independent as possible',
no assumption about underline macros is made.
Furthermore, it's assumed that *\maketitle* and the *abstract* environment
were modified by the underline class, so alternatives (based on the article class) are provided.
For more details, see the documentation,
[codedescribe.pdf](http://mirrors.ctan.org/macros/latex/contrib/codedescribe/doc/codedescribe.pdf)
--------------
## Requirements
* none besides a fairly recent LaTeX distribution as recent as 2022/06/01
(with the new in kernel *\ProcessKeyOptions* and *\NewDocumentCommand*)
## Installation
The stable version is available at [CTAN](https://ctan.org/pkg/codedescribe).
## Usage
### Stable version
Just place
```latex
\usepackage{codedescribe}
```
in the preamble and compile away.
Be aware that options might change between versions, so you have to check them manually.
## More Information and documentation
More Information can be found in the documentation; you can find a "bleeding edge" version
at [the github page](http://github.com/alceu-frigeri/codedescribe)
## Contacting Author
For bug reports and enhacement suggestions, the preferred way is to use
[the project's issue page](https://github.com/alceu-frigeri/codedescribe/issues).
Please be ready to provide an example code showing the bug, if any.
Please do not use the issue page for generic help on how to use the package.
* git: https://github.com/alceu-frigeri/codedescribe
-------------
Copyright 2023 by Alceu Frigeri
This work may be distributed and/or modified under the
conditions of
* The [LaTeX Project Public License](http://www.latex-project.org/lppl.txt), version 1.3c (or later), and/or
* The [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html), version 3 (or later)
This work has the LPPL maintenance status *maintained*.
The Current Maintainer of this work is Alceu Frigeri
-------------
## This work consists of the files
* codelisting.sty
- set of macros to typeset and demonstrate LaTeX code
* codedescribe.sty
- set of macros to document LaTeX packages
* README.md (this file)
- quick introduction
* codedescribe.tex
- package documentation
* codedescribe.pdf
- documentation in PDF format
-------------
## Changelog
* Version 1.0 (this)
- Initial release by CTAN
|