MultiMiner-Austria__Geologi.../README.md

51 lines
2.2 KiB
Markdown
Raw Normal View History

2024-02-16 14:16:59 +00:00
# MultiMiner, Austria — Geological Mapping Overview
2023-11-16 16:13:07 +00:00
2023-11-16 16:14:55 +00:00
This is the git repository for the [MultiMiner](https://www.multiminer.eu/) field guide for the geological mapping in Hochfilzen, Austria.\
2024-10-03 13:27:33 +00:00
The guide is available in [English](https://gitea.geologie.ac.at/schger/MultiMiner-Austria__Geological_Mapping_Overview/src/branch/master/MuMi_AT__MappingGuide__EN__V4.pdf) and [German](https://gitea.geologie.ac.at/schger/MultiMiner-Austria__Geological_Mapping_Overview/src/branch/master/MuMi_AT__MappingGuide__DE.pdf).
2023-11-16 16:13:07 +00:00
## Getting the source
You can clone this repository using:
```bash
git clone https://gitea.geologie.ac.at/schger/MultiMiner-Austria__Geological_Mapping_Overview.git
```
Alternatively you can [download](https://gitea.geologie.ac.at/schger/MultiMiner-Austria__Geological_Mapping_Overview/archive/master.zip) it if you don't use git.
## Building the documents
The two versions of this field guide are stored in two files:
1. English: `MuMi_AT__MappingGuide__EN.qmd`
2. German: `MuMi_AT__MappingGuide__DE.qmd`
The documents are rendered using _quarto_:
```bash
quarto render MuMi_AT__MappingGuide__EN.qmd
```
or
```bash
quarto preview MuMi_AT__MappingGuide__EN.qmd
```
2024-02-16 13:57:14 +00:00
The first command just renders the document to a PDF file. The latter command renders the document and opens up a browser window showing the built PDF.
2023-11-16 16:13:07 +00:00
2024-02-16 14:20:40 +00:00
Alternatively — and more comfortably — _quarto_ can be used with diverses editors resp. IDEs like _VS Code_, _RStudio_, _Jupyter Lab_, ...
2023-11-16 16:13:07 +00:00
### Prerequisites
2024-02-16 13:57:14 +00:00
You need to have the following things installed before you can build the documents:
2023-11-16 16:13:07 +00:00
* A [LaTeX](https://www.latex-project.org/) distribution
2024-02-16 14:22:49 +00:00
2023-11-16 16:13:07 +00:00
This depends on the system you are using:
* Linux and similar systems: Check your distribution's repository, usually a [TeX Live](https://www.tug.org/texlive/) distribution can be installed directly.
* Windows: [MiKTeX](https://miktex.org/) can be recommended or use [TeX Live](https://www.tug.org/texlive/).
* Mac OS: [MacTeX](https://www.tug.org/mactex/) will meet all your needs.
2024-02-16 13:49:05 +00:00
* [quarto](https://quarto.org/) -- see the _Get Started_ guide there
2024-02-16 13:57:14 +00:00
The documents are created using the [quarto_titlepages](https://github.com/nmfs-opensci/quarto_titlepages) extension, which is included in this repository.