summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/easyfloats/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-12-21 03:01:35 +0000
committerNorbert Preining <norbert@preining.info>2020-12-21 03:01:35 +0000
commit4cc7922324b7a08ba0418e8f245cf1dcfa1891ac (patch)
treecd90cb6c072285e779f7555a85966b81a8757e15 /macros/latex/contrib/easyfloats/README.md
parent2d9d44100d72263a7df34c12aaa89dbe6ee6fe0c (diff)
CTAN sync 202012210301
Diffstat (limited to 'macros/latex/contrib/easyfloats/README.md')
-rw-r--r--macros/latex/contrib/easyfloats/README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/macros/latex/contrib/easyfloats/README.md b/macros/latex/contrib/easyfloats/README.md
new file mode 100644
index 0000000000..58cca59837
--- /dev/null
+++ b/macros/latex/contrib/easyfloats/README.md
@@ -0,0 +1,49 @@
+# Abstract
+
+In standard LaTeX inserting objects like figures or tables requires too much knowledge for beginners and too much typing effort and hardcoding for people like me.
+This package aims to make insertion of figures and tables easier for both beginners and experts.
+Despite the term *floats* in it's name it also allows to disable floating of such objects.
+
+
+# Documentation
+
+The documentation is contained in the file [doc/easyfloats.pdf](doc/easyfloats.pdf).
+
+The source code for the documentation is *not* contained in the dtx file but in the directory [doc](doc).
+To build the documentation run:
+```sh
+cd doc
+pdflatex easyfloats.tex
+biber easyfloats
+pdflatex easyfloats.tex
+pdflatex easyfloats.tex
+```
+
+
+# Dependencies
+
+The dependencies are listed in [DEPENDS.txt](DEPENDS.txt).
+It's syntax is explained on http://tug.org/texlive/pkgcontrib.html#deps.
+See also section *Used packages* in the [documentation](doc/easyfloats.pdf).
+
+
+# License
+
+This package and it's documentation are distributed under the [LaTeX Project Public License](https://www.latex-project.org/lppl/), version 1.3 or later.
+The preamble of the documentation may alternatively, at your choice, be reused under the terms of the [WTFPL](http://www.wtfpl.net/), version 2 or later.
+
+Additionally to the rights granted by the LaTeX Project Public License
+you have permission to freely distribute *unmodified* copies
+of the files [easyfloats.sty](easyfloats.sty) and [doc/easyfloats.pdf](doc/easyfloats.pdf) without other files of this work.
+The other files of this work can be found at:
+https://gitlab.com/erzo/latex-easyfloats
+
+The examples and tests are distributed under the [WTFPL](http://www.wtfpl.net/), version 2 or later.
+
+
+# Contact
+
+Bug reports and feature requests can be submitted at
+https://gitlab.com/erzo/latex-easyfloats/-/issues.
+
+Please see also section *Bug reports and contributions* in the [documentation](doc/easyfloats.pdf).