From 2b3e40d39e1213e36e48d6b72437487e11dbe96f Mon Sep 17 00:00:00 2001 From: Leroy Hopson Date: Mon, 20 Jul 2020 11:30:30 +0700 Subject: [PATCH] Update README with note about native branch --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a8ab21..574cfa9 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,9 @@ ![License](https://img.shields.io/badge/license-MIT-green.svg) -Xterm for Godot. -This is still very much a work in progress. +**NOTE: The GDScript version of this project turned out to be very buggy and performed poorly. I have had much more success with a gdnative implementation using [libtsm](https://github.com/Aetf/libtsm) which can be viewed in the [native branch](https://github.com/lihop/godot-xterm/tree/native) of this repo.** + +Xterm for Godot. This is still very much a work in progress. Most of the credit goes to the authors of [xterm.js](https://github.com/xtermjs/xterm.js) as most of this code was taken from that project and translated to GDScript. ## Demo