From 8a02ce48420c5a4d4f9b859ce63c710ec1270eeb Mon Sep 17 00:00:00 2001 From: Florian Knoch Date: Wed, 14 Apr 2021 11:55:00 +0200 Subject: [PATCH] Start working on the README --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..4337a2a --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# LaTeX Script by Fachschaft WIAI + +This script introduces the most fundamental LaTeX mechanisms to get students started. It is used both as a reference and as exercise material for our [LaTeX workshop](https://wiai.de/latex-weekend), a **two-day tutorial aimed at students from various backgrounds**. At the moment, it is only available in German. The following topics are covered: + +* general introduction to the LaTeX system +* basic document structure +* structuring a more complex project +* special characters +* text markup +* formatting paragraphs +* lists +* maths and formulas +* sourcecode listings +* graphics +* tables +* footnotes +* references +* literature management + +Most chapters contain exercises to be performed within the script itself, practically teaching the aspects that are introduced by the text. + +## Requirements + +Compiling the script requires a working LaTeX installation. +For sourcecode listings, we are using Pygments and Python3. +The Makefile comes in handy for compiling the different versions of the script (see usage section). + +TODO: Add detailed explanation. + +## Usage + +TODO: Describe the project setup. + +## Contributing + +You are welcome to contribute to this project by creating issues, opening pull requests, or reporting bugs. Note that our goal is to keep the content rather condensed, so we might not choose to incorporate further sections. + +These are the contributors so far: +TODO: Add them. + +## License + +TODO: Add license. \ No newline at end of file