Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xtyxtyx committed Oct 2, 2020
1 parent c0b6a71 commit ffa83c5
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Terminal Lite

Experimental terminal emulator application written in Flutter.
Experimental cross-platform terminal emulator application written in Flutter.

## Screenshots

Expand Down Expand Up @@ -31,8 +31,22 @@ Experimental terminal emulator application written in Flutter.

## Build

**Flutter 1.22.0+ is recommended to build Terminal Lite.**

```
flutter packages get
flutter packages upgrade
flutter pub get
flutter pub upgrade
flutter run --release
```
```

## Known Issues

- [Pty](https://github.com/TerminalStudio/pty) may not work in **debug mode**.
- Some special characters may not render in **MacOS**, maybe caused by [fontFamilyFallback](https://github.com/TerminalStudio/xterm.dart/blob/2800cfba0e1a945b3588e5658cf0801684c91027/lib/theme/terminal_style.dart#L2)?
- When multiple tabs are opened, focus may not move between those tabs correctly.

## Features and bugs

Please file feature requests and bugs at the [issue tracker](https://github.com/TerminalStudio/lite/issues).

Contributions are always welcome!

0 comments on commit ffa83c5

Please sign in to comment.