traintastic/README.md

# Traintastic - Model railway control software

[![Release](https://img.shields.io/github/v/release/traintastic/traintastic?sort=semver)](https://github.com/traintastic/traintastic/releases)
[![Build](https://github.com/traintastic/traintastic/actions/workflows/build.yml/badge.svg)](https://github.com/traintastic/traintastic/actions/workflows/build.yml) [![License](https://img.shields.io/github/license/traintastic/traintastic)](https://github.com/traintastic/traintastic/blob/master/LICENSE)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/traintastic/traintastic)](https://github.com/traintastic/traintastic/graphs/commit-activity)
[![Coverage Status](https://coveralls.io/repos/github/traintastic/traintastic/badge.svg?branch=master)](https://coveralls.io/github/traintastic/traintastic?branch=master)

![POEditor](https://img.shields.io/poeditor/progress/622757/en-us?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/nl?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/de?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/it?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/sv?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/fr?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/es?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/pl?token=6428931964d7cdf58536a518443ebe16)
![POEditor](https://img.shields.io/poeditor/progress/622757/fy?token=6428931964d7cdf58536a518443ebe16)

## About The Project
Traintastic is a client/server software application to control a model railway. It is in an early stage of development, it contains very limited functionality.

The project goal is to develop open source software that can control everything in your model railway layout. More information can be found using the links below:

- [Join the Traintastic forum](https://discourse.traintastic.org/)
- [Download Traintastic](https://traintastic.org/download)
- [Traintastic Manual](https://traintastic.org/manual)
- [Traintastic hardware support](https://traintastic.org/supported-hardware)
- [Traintastic development roadmap](https://traintastic.org/roadmap)


## Build Traintastic from source

*Only for developers, if your just want to use it [download Traintastic](https://traintastic.org/download).*

See [BUILDING.md](BUILDING.md).

## Legal Notes

This project includes an independent implementation of the LocoNet® protocol,
based on reverse engineering and publicly observable behavior.
It does not use or include Digitrax’s confidential documentation.

If you have signed an NDA with Digitrax regarding LocoNet, **you cannot
contribute to the LocoNet-related parts of this project**, as that would risk
contaminating the open source implementation with NDA-covered information.

## Trademarks

LocoNet® is a registered trademark of Digitrax, Inc.
This project is not affiliated with, endorsed by, or connected to Digitrax.

## Contributors

<!-- readme: contributors -start -->
<table>
	<tbody>
		<tr>
            <td align="center">
                <a href="https://github.com/reinder">
                    <img src="https://avatars.githubusercontent.com/u/886282?v=4" width="100;" alt="reinder"/>
                    <br />
                    <sub><b>Reinder Feenstra</b></sub>
                </a>
            </td>
            <td align="center">
                <a href="https://github.com/gfgit">
                    <img src="https://avatars.githubusercontent.com/u/42845724?v=4" width="100;" alt="gfgit"/>
                    <br />
                    <sub><b>Null</b></sub>
                </a>
            </td>
            <td align="center">
                <a href="https://github.com/DrEVILish">
                    <img src="https://avatars.githubusercontent.com/u/6287003?v=4" width="100;" alt="DrEVILish"/>
                    <br />
                    <sub><b>Ryan Freeman</b></sub>
                </a>
            </td>
            <td align="center">
                <a href="https://github.com/cyrilpawelko">
                    <img src="https://avatars.githubusercontent.com/u/1159809?v=4" width="100;" alt="cyrilpawelko"/>
                    <br />
                    <sub><b>Cyril Pawelko</b></sub>
                </a>
            </td>
            <td align="center">
                <a href="https://github.com/kamil00110">
                    <img src="https://avatars.githubusercontent.com/u/68923965?v=4" width="100;" alt="kamil00110"/>
                    <br />
                    <sub><b>kamil00110</b></sub>
                </a>
            </td>
            <td align="center">
                <a href="https://github.com/memen45">
                    <img src="https://avatars.githubusercontent.com/u/27782135?v=4" width="100;" alt="memen45"/>
                    <br />
                    <sub><b>Null</b></sub>
                </a>
            </td>
		</tr>
	<tbody>
</table>
<!-- readme: contributors -end -->