improve readme like efl, rage, e etc.

This commit is contained in:
Carsten Haitzler 2022-06-04 16:19:41 +01:00
parent a1b0cf0cca
commit dac6910c21
1 changed files with 92 additions and 110 deletions

View File

@ -1,12 +1,12 @@
Terminology 1.12.1
==================
![Terminology](/data/icons/terminology.png)
# Terminology
This is an EFL terminal emulator with some extra bells and whistles.
:warning: :warning: :warning:
> FOR ANY ISSUES, PLEASE CONSULT THEM ON
> http://issues.terminolo.gy/
*Please report bugs/issues at*
[git.enlightenment.org](https://git.enlightenment.org/enlightenment/terminology/issues)
:warning: :warning: :warning:
@ -17,24 +17,20 @@ This is an EFL terminal emulator with some extra bells and whistles.
[![Snapcraft](https://snapcraft.io//terminology/badge.svg)](https://snapcraft.io/terminology)
[![Weblate](https://hosted.weblate.org/widgets/terminology/-/terminology/svg-badge.svg)](https://hosted.weblate.org/engage/terminology/)
Requirements
------------
## Requirements
* `efl` (>= 1.26.0)
* [efl](https://git.enlightenment.org/enlightenment/efl)
Please see http://www.enlightenment.org for information on these.
Compiling
---------
## Compiling
Once you have met requirements, compiling and installing is simple:
``` sh
meson build
cd build
ninja
ninja install
ninja -C build
sudo ninja -C build install
```
Note: to make terminology work with input methods in general you need:
@ -44,28 +40,21 @@ Note: to make terminology work with input methods in general you need:
export XMODIFIERS="@im=none"
```
Themes
------
## Themes
Apart from the ones shipped with Terminology, themes can be stored in
`~/.config/terminology/themes/`.
Documentation on themes is written in [THEMES.md](THEMES.md).
Color Schemes
-------------
## Color Schemes
Terminology ships with some common color schemes.
To know how to modify or add some new color schemes, please read
[COLORSCHEMES.md](COLORSCHEMES.md).
Mouse controls
--------------
## Mouse controls
* `Right mouse button` = controls menu
* `Middle mouse button` = paste highlight selection
@ -74,9 +63,7 @@ Mouse controls
* `Ctrl+Wheel` = zoom font size up/down
* `Ctrl+Left mouse button/drag` = make block selection highlight
Default key controls
--------------------
## Default key controls
* `Shift+PgUp` = Scroll 1 page up
* `Shift+PgDn` = Scroll 1 page down
@ -127,11 +114,7 @@ Default key controls
* `Ctrl+9` = switch to terminal tab 9
* `Ctrl+0` = switch to terminal tab 10
Companion tools
---------------
## Companion tools
Terminology ships with a set of tools to help you get the best out of
Terminology.
@ -144,10 +127,7 @@ Terminology.
* `tyq`: queue media files or URI to be popped up
* `tysend`: send files to the terminal (useful through ssh)
Extended escapes for terminology only
--------------------------------------
## Extended escapes for terminology only
`[\033][}][COMMAND][\000]`
i.e.
@ -157,14 +137,16 @@ i.e.
4. `\000` char (`nul` byte or `0x00` to indicate end of sequence)
e.g.
``` sh
`echo -n '\033}Hello world\000'`
```
## Commands
In the following, any values inside square brackets `[]` are to be replaced
by some content (numbers, strings, paths, url's etc.).
examples:
Examples:
* `aa[PATH-OF-FILE]` should become something like: `aa/tmp/file.png`
* `aa[true/false]` should become something like: `aatrue` or `aafalse`