Skip to content

Commit

Permalink
Traktor: Tweaked the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
apistol78 committed Apr 12, 2024
1 parent 3b7f0cd commit cbe5efa
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
# Traktor
Traktor is an open source C++ engine which has been used in a couple of commercial titles on Steam, PSN, iOS and Mac Store.
Traktor is an open-source C++ engine, it has powered several successful commercial titles across various platforms including Steam, PSN, iOS, and the Mac Store.

![image info](resources/documentation/images/screenshot%20-%20editor%20-%2003.png)

# Why?
Traktor isn't just another engine; it's a meticulously crafted toolkit designed for optimal performance and flexibility. Here's why it stands out:

* **Lean and Well-Designed:** Each module boasts clean responsibilities, ensuring an elegant and efficient codebase.

* **Minimal Footprint:** Traktor prioritizes low memory and storage usage, ensuring streamlined performance.

* **Optimized for Efficiency:** Utilizing modern rendering techniques and efficient algorithms, Traktor delivers exceptional performance.

* **Tailored Flexibility:** Unlike bloated, one-size-fits-all engines, Traktor is customizable to fit the unique needs of every project.

# Supported platforms
Currently Traktor is supported on Windows and Linux. Mobile versions (Android and iOS) are non-tested but kept up-to-date code wise.
Traktor currently offers full support for Windows and Linux platforms. While mobile versions for Android and iOS are available, they are not officially tested but are regularly updated to maintain compatibility.

# Prebuilt binaries
See [releases](https://github.com/apistol78/traktor/releases) for prebuilt binaries. However the releases should not be expected to be latest and therefor we recommend building the engine from source for latest bug fixes and features.

# How to build
[Linux](resources/documentation/markdown/Build%20Linux.md)
**Linux:** Refer to [Build Linux](resources/documentation/markdown/Build%20Linux.md) for detailed instructions.

[Windows](resources/documentation/markdown/Build%20Windows.md)
**Windows:** Follow the guidelines outlined in [Build Windows](resources/documentation/markdown/Build%20Windows.md) for seamless setup.

# Features

Expand All @@ -29,7 +40,7 @@ See [releases](https://github.com/apistol78/traktor/releases) for prebuilt binar

- Advanced frame graph based renderer using Vulkan.
- GPU based occlusion culling (work in progress).
- Graph based shader editor with possibility to inline shader code if necessary.
- Graph based shader editor with possibility to inline shader code when necessary.
- Tile based deferred and forward+ rendering paths.

## Scripting
Expand Down

0 comments on commit cbe5efa

Please sign in to comment.