From a6243d819c687e67809202c3923ab2521abccdbd Mon Sep 17 00:00:00 2001
From: Tristan Walter <mooch443@googlemail.com>
Date: Tue, 13 Oct 2020 15:44:21 +0200
Subject: [PATCH] Create README.md

---
 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..d095b45
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+<p align="center"><img src="https://github.com/mooch443/trex/blob/master/images/Icon1024.png" width="160px"></p>
+
+# Hey there
+
+Welcome to the git repository of **TRex** (https://trex.run), a video-based multi-object tracking software with recording and visual identification capabilities.
+
+TRex can track 256 individuals in real-time, or up to 128 with all fancy features like posture estimation enabled, and for up to 100 individuals allows you to 
+(when realtime speed is not required) visually recognize individuals and automatically correct potential tracking errors.
+
+This package includes a complementary tool, called **TGrabs**, which is used to directly process already saved videos, or to record directly from 
+webcams and/or Basler machine-vision cameras (but can be extended for other APIs with a bit of C++ knowledge) with integrated and customizable closed-loop support.
+
+# Installation
+
+Create a new virtual conda environment on macOS/Windows, using:
+
+```
+conda create -n tracking -c trexing trex                   # macOS, Windows
+```
+or, add the `conda-forge` channel for Linux:
+```
+conda create -n tracking -c conda-forge -c trexing trex    # Linux
+```
+
+If you want compatibility with the Basler API (or other things with licensing/portability issues), please 
+use one of the manual compilation options (see https://trex.run/docs/install.html).
+
+# Contributors, Issues, etc.
+
+This project has been developed, is still being updated, by [Tristan Walter](http://moochm.de).
+If you want to contribute, please submit a pull request on github and I will be happy to credit you here, for any substantial contributions!
+
+If you have any issues running the software please consult the documentation first (especially the FAQ section) 
+and if this does not solve your problem, please file an issue using the [issue tracker](https://github.com/mooch443/trex/issues) here on github. 
+If you experience problems with [Tensorflow](https://tensorflow.org), such as installing CUDA or cuDNN dependencies, then please direct issues to those development teams.
+
+# Example data
+
+See https://trex.run/docs/examples.html.
+
+# License
+
+Released under the GPLv3 License (see [LICENSE](https://github.com/mooch443/trex/blob/master/LICENSE)).
-- 
GitLab