interesting
/
aminal
mirror of https://github.com/liamg/aminal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Liam Galvin 2018-08-08 16:52:59 +00:00
parent aa8034f266
commit 1834d2bf2a
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,6 +1,6 @@
Raft is a terminal emulator utilising OpenGL v4.1. Raft is a modern terminal emulator utilising OpenGL.
The project is purely a learning exercise right now. The project is experimental at the moment, so you probably won't want to rely on Raft as your main terminal for a while.
Ensure you have your latest graphics card drivers installed before use. Ensure you have your latest graphics card drivers installed before use.
@ -9,10 +9,14 @@ Ensure you have your latest graphics card drivers installed before use.
- Full unicode support - Full unicode support
- OpenGL rendering - OpenGL rendering
- Full customisation options - Full customisation options
- 256 colour support - True colour support
- Support for commmon ANSI escape sequences a la xterm
- Scrollback buffer
- Clipboard access - Clipboard access
- Clickable URLs - Clickable URLs
- Resize logic that wraps/unwraps lines _correctly_
- Bullshit graphical effects
- Multi platform support
## Build Dependencies ## Build Dependencies
@ -27,24 +31,24 @@ Ensure you have your latest graphics card drivers installed before use.
| Platform | Supported | | Platform | Supported |
|----------|------------| |----------|------------|
| Linux | ✔ | Linux | ✔
| MacOSX | | MacOSX | ⏳
| Windows | | Windows | ⏳
## Planned Features ## Planned Features
| Feature | Done | Notes | | Feature | Done | Notes |
|-----------------------------|------|-------| |-----------------------------|------|-------|
| Pty allocation | ✔ | Needs work for other platforms | Pty allocation | ✔ | Needs work for OSX + Windows
| OpenGL rendering | ✔ | | OpenGL rendering | ✔ |
| Resizing/content reordering | ✔ | | Resizing/content reordering | ⏳ |
| ANSI escape codes | | Most of these are handled now | ANSI escape codes | ⏳ | Most of these are handled now
| UTF-8 input | ✔ | | UTF-8 input | ✔ |
| UTF-8 output | ✔ | Works as long as the font in use supports the relevant characters. | UTF-8 output | ✔ | Works as long as the font in use supports the relevant characters.
| Copy/paste | | Paste working, no mouse interaction for copy | Copy/paste | | Paste working, no mouse interaction for copy
| Customisable colour schemes | ✔ | Complete, but the config file has no entry for this yet | Customisable colour schemes | ✔ | Complete, but the config file has no entry for this yet
| Config file | ✔ | Minimal options atm | Config file | ⏳ | Minimal options atm
| Scrolling | | Infinite buffer implemented, need GUI scrollbar & render updates | Scrolling | ⏳ | Infinite buffer implemented, need GUI scrollbar & render updates
| Mouse interaction | | | Mouse interaction | |
| Sweet render effects | | | Sweet render effects | |