Jasima/godot-xterm
1
0
Fork 0
mirror of https://github.com/lihop/godot-xterm.git synced 2025-05-23 03:05:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(rtd): move documentation to read the docs

Browse source
This commit is contained in:
Leroy Hopson 2024-03-29 19:07:43 +13:00
parent 4fec353509
commit 5ae8d6a982
No known key found for this signature in database
GPG key ID: D2747312A6DB51AA
45 changed files with 609 additions and 772 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/index.md
View file

@ -1,8 +1,30 @@
---
layout: default
title: Introduction
nav_order: 1
permalink: /
---
<img align="left" width="64" height="64" src="./_static/images/icon.png">
{% include_relative README.md %}
# GodotXterm - Terminal Emulator
<br/>
[![Godot Version](https://img.shields.io/badge/Godot-3.4.x-blue.svg)](#supported-godot-versions)
[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/lihop/godot-xterm/blob/stable/LICENSE.md)
[![Build and Test](https://github.com/lihop/godot-xterm/actions/workflows/main.yml/badge.svg?event=schedule)](https://github.com/lihop/godot-xterm/actions/workflows/main.yml)
GDNative terminal for Godot.
Built using [libtsm](https://www.freedesktop.org/wiki/Software/libtsm/), [libuv](https://github.com/libuv/libuv), and [node-pty](https://github.com/microsoft/node-pty).
Primarily developed and tested on Linux, it also supports macOS with partial support for Windows and HTML5. See the [Features section](introduction.md#features) for more detail.
<video width="100%" controls>
<source src="https://user-images.githubusercontent.com/3696783/126894061-a69eb6ad-9979-4723-ade7-829494a9fc87.mp4" />
</video>
[![Live Demo](./_static/images/button_live_demo.png)](https://lihop.github.io/godot-xterm-dist/demo)
[![View it on GitHub](./_static/images/button_view_it_on_github.png)](https://github.com/lihop/godot-xterm)
```{toctree}
:maxdepth: 2
:caption: Table of Contents
introduction
setup/index
api/index
CHANGELOG
```