Update the README

This commit is contained in:
Leroy Hopson 2020-05-10 02:33:54 +07:00
parent 96e9ddcf79
commit fc27f9cf95
2 changed files with 27 additions and 1 deletions

View file

@ -4,4 +4,30 @@
[![Build Status](https://travis-ci.com/lihop/godot-xterm.svg?branch=master)](https://travis-ci.com/lihop/godot-xterm)
[Xterm.js](https://github.com/xtermjs/xterm.js) for Godot.
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
If you are running Linux and have `which`, `bash` and `socat` installed you can run the main scene (`demo.tscn`) and it will try
to connect the Terminal node to your system.
Otherwise you can check out the gif below:
<img src="demo.gif">
## Testing
This project uses the awesome [Gut](https://github.com/bitwes/Gut) (Godot Unit Testing) plugin for testing.
You can run the tests by playing the test scene at `res://test/test.tscn` and clicking run.
## License
If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license.
You are also implicitly verifying that all code is your original work, or unoriginal work which is published under a compatible license or waiver.
Copyright (c) 2020, [The GodotXterm authors](https://github.com/lihop/godot-xterm/graphs/contributors) (MIT License)<br>
Copyright (c) 2017-2019, [The xterm.js authors](https://github.com/xtermjs/xterm.js/graphs/contributors) (MIT License)<br>
Copyright (c) 2014-2017, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)<br>
Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)

BIN
demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB