Debian Codegraph @

texmf-dist/doc/latex/tikz-trackschematic/README.md

raw
1 # TikZ-trackschematic
2
3 [![License: ISC](https://img.shields.io/badge/license-ISC-green.svg)](https://opensource.org/licenses/ISC) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5539844.svg)](https://doi.org/10.5281/zenodo.5539844) [![continuous integration test](https://github.com/railtoolkit/tikz-trackschematic/actions/workflows/testing.yml/badge.svg)](https://github.com/railtoolkit/tikz-trackschematic/actions/workflows/testing.yml)
4
5 ------------
6
7 # Installation
8
9
10 The tikz library is contained in the files:
11 * tikz-trackschematic.sty
12 * tikzlibrarytrackschematic.code.tex,
13 * tikzlibrarytrackschematic.topology.code.tex,
14 * tikzlibrarytrackschematic.trafficcontrol.code.tex,
15 * tikzlibrarytrackschematic.vehicles.code.tex,
16 * tikzlibrarytrackschematic.constructions.code.tex,
17 * tikzlibrarytrackschematic.symbology.code.tex,
18 * tikzlibrarytrackschematic.electrics.code.tex, and
19 * tikzlibrarytrackschematic.measures.code.tex.
20
21 These files should be copied wherever TeX can find it, for example in your $TEXMF folder.
22
23 Alternatively, the tikz library is provided by CTAN as "[tikz-trackschematic](https://ctan.org/pkg/tikz-trackschematic)" and is thus part of the TeX Live distribution or can be installed via MiKTeX.
24
25 The library can then be loaded through the command
26 ```TeX
27 \usepackage{tikz-trackschematic}
28 ```
29 in any LaTeX file.
30
31 The library can also be used in [Overleaf](https://www.overleaf.com/read/crrxfcdzbhbd).
32
33 ------------
34
35 # Minimal working example
36
37 ```TeX
38 \documentclass{standalone} % LaTeX
39 \usepackage{tikz-trackschematic} % loading the library
40
41 \begin{document}
42 \begin{tikzpicture}
43
44 % TikZ command: specify coordinates
45 \coordinate (A) at (0,0);
46 \coordinate (B) at (6,0);
47 \coordinate (T) at (5,0);
48
49 % draw a track
50 \maintrack (A) -- (B);
51
52 % place a train on the track
53 \train[forward] at (T) label ();
54
55 \end{tikzpicture}
56 \end{document}
57 ```
58 results in:
59
60 ![train on a track](https://raw.githubusercontent.com/railtoolkit/tikz-trackschematic/master/doc/examples/minimal_working_example.png "train on a track")
61
62 ------------
63
64 # Symbology and meaning
65
66 Please consult the [symbology table](https://github.com/railtoolkit/tikz-trackschematic/blob/master/doc/symbology-table.pdf) for further information regarding meaning of the symbols.
67
68 ------------
69
70 # Roadmap
71
72 * rethink syntax
73 * provide option for internationalziation (i18n)
74 * rewrite library with better coding skills
75 * include support for glossaries package
76
77 ------------
78
79 # Acknowledgement
80
81 This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No. 826347.
82
83 ------------
84
85 # License
86
87 [![Open Source Initiative Approved License logo](https://opensource.org/files/OSIApproved_100X125.png "Open Source Initiative Approved License logo")](https://opensource.org)
88
89 Copyright (c) 2018 - 2022, Martin Scheidt \<[email protected]\> (ISC License)
90
91 Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
92
93 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.