summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/minimalist/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/minimalist/README.md')
-rw-r--r--macros/latex/contrib/minimalist/README.md41
1 files changed, 21 insertions, 20 deletions
diff --git a/macros/latex/contrib/minimalist/README.md b/macros/latex/contrib/minimalist/README.md
index 3c4ecee278..a86486ba21 100644
--- a/macros/latex/contrib/minimalist/README.md
+++ b/macros/latex/contrib/minimalist/README.md
@@ -1,24 +1,26 @@
-<!-- Copyright (C) 2021-2022 by Jinwen XU -->
+<!-- Copyright (C) 2021-2023 by Jinwen XU -->
# `minimalist` bundle: write you documents in a simple and clear way
-<!--
-**The whole series have been rewritten with `expl3`. Please note that the documentations are not yet up-to-date. The syntax of some commands have been changed since the last version, especially the declaration of theorem-like environments by `\CreateTheorem`. For the moment, you can refer to the documentation of the package `create-theorem`.** -->
+
+> **New documentations are being written and are expected to be completed by the end of 2023. In the meantime, only the core code would be included in TeX Live 2023 coming this April (old documentations have been removed from the distribution).**
## Introduction
-`minimalist` is a collection of styles and classes that helps you typesetting articles and books
-with a simple and clear design. It mainly consists of two parts.
+`minimalist` is a collection of styles and classes that helps you to typeset articles and books with a simple and clear design.
+
+It mainly consists of two parts.
- Main part:
- `minimalist.sty` : interface of the main style
- - `minimalist-plain.sty` : the plain style
- - `minimalist-classical.sty` : the classical style
- - `minimalist-stream.sty` : the stream style
- - `minimalist-flow.sty` : the flow style
+ - `minimalist-plain.sty` : the style "plain"
+ - `minimalist-classical.sty` : the style "classical"
+ - `minimalist-flow.sty` : the style "flow"
+ - `minimalist-stream.sty` : the style "stream"
+ - ... and more styles to come (currently on schedule: "modern")
- `minimart.cls` : class for typesetting articles
- `minimbook.cls` : class for typesetting books
- They can be used with any major TeX engine. Currently they have native
+ They can be used with any major TeX engine. Currently, they have native
support to English, French, German, Italian, Portuguese
(European and Brazilian) and Spanish typesetting.
@@ -27,13 +29,13 @@ with a simple and clear design. It mainly consists of two parts.
- `einfart.cls` : more advanced class for typesetting articles
- `simplivre.cls` : more advanced class for typesetting books
- They are similar to the main classes, but have unicode support, thus can
- only be used with either XeLaTeX or LuaLaTeX. Currently they have native
+ They are similar to the main classes, but have Unicode support, thus can
+ only be used with either XeLaTeX or LuaLaTeX. Currently, they have native
support to Chinese (simplified and traditional), English, French, German,
Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish
typesetting, and also use more beautiful fonts.
-<!-- ### How to get these files
+### How to get these files
You can get the `.sty` and `.cls` files mentioned above simply by compiling
`minimalist.ins`:
```
@@ -43,19 +45,18 @@ To get the `.tex` source files of the documentation, compile
`minimalist-doc.ins`:
```
latex minimalist-doc.ins
-``` -->
+```
## Features
Compared with usual document classes, it has the following features:
-- Native multi-language support: Chinese (simplified and traditional), English,
- French, German, Italian, Japanese, Portuguese (European and Brazilian),
- Russian and Spanish
- > In particular, for simplified Chinese, traditional Chinese and Japanese,
- > the fonts of the corresponding glyphs can be automatically switched
-- Ready-to-use theorem-like environments, also with multi-language support
+- Several carefully designed styles
+- Native multi-language support: Chinese (simplified and traditional), English, French, German, Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish
+ > In particular, for simplified Chinese, traditional Chinese and Japanese, the fonts of the corresponding glyphs can be automatically switched
+- Ready-to-use theorem-like environments, with clever referencing support
- Support both the standard and the AMS writing fashion
+- ... and so much more...
# License