Merge branch 'master' into vertical-resize-improvements

This commit is contained in:
Liam Galvin 2018-10-24 10:26:50 +01:00 committed by GitHub
commit d181215a4f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 21 deletions

View File

@ -1,9 +1,10 @@
# Aminal - A Modern Terminal Emulator
[![CircleCI](https://circleci.com/gh/liamg/aminal/tree/master.svg?style=svg)](https://circleci.com/gh/liamg/aminal/tree/master)
Aminal is a modern terminal emulator implemented in Golang and utilising OpenGL. So far the terminal is very much incomplete, but we're getting there!
![Example screenshot](demo.png)
![Example screenshot](demo.gif)
The project is experimental at the moment, so you probably won't want to rely on Aminal as your main terminal for a while.
@ -31,7 +32,6 @@ Ensure you have your latest graphics card drivers installed before use.
<img alt="Overheating" src="https://imgs.xkcd.com/comics/workflow.png"/>
</p>
## Build Dependencies
- Go 1.10.3+
@ -39,15 +39,13 @@ Ensure you have your latest graphics card drivers installed before use.
- On Ubuntu/Debian-like Linux distributions, you need `libgl1-mesa-dev xorg-dev`.
- On CentOS/Fedora-like Linux distributions, you need `libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel`.
## Platform Support
| Platform | Supported |
|----------|------------|
| Linux | ✔
| MacOSX | ⏳
| Windows | ⏳
| -------- | --------- |
| Linux | ✔ |
| MacOSX | ⏳ |
| Windows | ⏳ |
## Planned Features
@ -71,10 +69,10 @@ Ensure you have your latest graphics card drivers installed before use.
## Keyboard Shortcuts
| Operation | Key(s) |
|--------------------|---------------------|
| Paste | ctrl + shift + v
| Toggle slomo | ctrl + shift + ;
| Interrupt (SIGINT) | ctrl + c
| ------------------ | ---------------- |
| Paste | ctrl + shift + v |
| Toggle slomo | ctrl + shift + ; |
| Interrupt (SIGINT) | ctrl + c |
## Configuration
@ -85,9 +83,7 @@ You can ignore the config and use defaults by specifying `--ignore-config` as a
### Config Options/CLI Flags
| CLI Flag | Config Section | Config Name | Type | Default | Description |
|--------------------|---------------------|------------------------|---------|--------------|-------------|
| --debug | _root_ | debug | boolean | false | Enable debug mode, with debug logging and debug info terminal overlay.
| --slomo | _root_ | slomo | boolean | false | Enable slomo mode, delay the handling of each incoming byte (or escape sequence) from the pty by 100ms. Useful for debugging.
| --always-repaint | rendering | always_repaint | boolean | false | Redraw the terminal GUI constantly, even when no changes have occurred.
| ---------------- | -------------- | -------------- | ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| --debug | _root_ | debug | boolean | false | Enable debug mode, with debug logging and debug info terminal overlay. |
| --slomo | _root_ | slomo | boolean | false | Enable slomo mode, delay the handling of each incoming byte (or escape sequence) from the pty by 100ms. Useful for debugging. |
| --always-repaint | rendering | always_repaint | boolean | false | Redraw the terminal GUI constantly, even when no changes have occurred. |

BIN
demo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 347 KiB

BIN
demo.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 371 KiB