amass/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2024-11-22 18:59:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix typos in README (#349)

Browse Source
This commit is contained in:
IsakTheHacker 2022-03-01 19:07:50 +01:00 committed by GitHub
parent 3fe12b8a2f
commit 9dbc23a7d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -11,7 +11,7 @@
<br/> <br/>
<a href="https://arthursonzogni.github.io/FTXUI/">Documentation</a> · <a href="https://arthursonzogni.github.io/FTXUI/">Documentation</a> ·
<a href="https://github.com/ArthurSonzogni/FTXUI/issues">Report Bug</a> · <a href="https://github.com/ArthurSonzogni/FTXUI/issues">Report a Bug</a> ·
<a href="https://arthursonzogni.github.io/FTXUI/examples.html">Examples</a> . <a href="https://arthursonzogni.github.io/FTXUI/examples.html">Examples</a> .
<a href="https://github.com/ArthurSonzogni/FTXUI/issues">Request Feature</a> · <a href="https://github.com/ArthurSonzogni/FTXUI/issues">Request Feature</a> ·
<a href="https://github.com/ArthurSonzogni/FTXUI/pulls">Send a Pull Request</a> <a href="https://github.com/ArthurSonzogni/FTXUI/pulls">Send a Pull Request</a>
@ -22,21 +22,21 @@
<i>Functional Terminal (X) User interface</i> <i>Functional Terminal (X) User interface</i>
A simple C++ library for terminal based user interface. A simple C++ library for terminal based user interfaces!
## Feature ## Feature
* Functional style. Inspired by * Functional style. Inspired by
[[1]](https://hackernoon.com/building-reactive-terminal-interfaces-in-c-d392ce34e649?gi=d9fb9ce35901) [[1]](https://hackernoon.com/building-reactive-terminal-interfaces-in-c-d392ce34e649?gi=d9fb9ce35901)
and [React](https://reactjs.org/) and [React](https://reactjs.org/)
* Simple and elegant syntax (in my opinion). * Simple and elegant syntax (in my opinion)
* Support for [UTF8](https://en.wikipedia.org/wiki/UTF-8) and [fullwidth chars](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) (→ 测试). * Support for [UTF8](https://en.wikipedia.org/wiki/UTF-8) and [fullwidth chars](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) (→ 测试)
* No dependencies. * No dependencies
* Cross platform. Linux/mac (main target), Windows (experimental thanks to contributors), WebAssembly. * Cross platform. Linux/MacOS (main target), Windows (experimental thanks to contributors), WebAssembly
* Keyboard & mouse navigation. * Keyboard & mouse navigation
## Operating systems ## Operating systems
- Webassembly - WebAssembly
- Linux - Linux
- MacOS - MacOS
- Windows - Windows
@ -120,13 +120,13 @@ An element can be decorated using the functions:
![image](https://user-images.githubusercontent.com/4759106/147244118-380bf834-9e33-40df-9ff0-07c10f2598ef.png) ![image](https://user-images.githubusercontent.com/4759106/147244118-380bf834-9e33-40df-9ff0-07c10f2598ef.png)
FTXUI support the pipe operator. It means: `decorator1(decorator2(element))` and `element | decorator1 | decorator2` can be used. FTXUI supports the pipe operator. It means: `decorator1(decorator2(element))` and `element | decorator1 | decorator2` can be used.
</details> </details>
<details><summary>Colors</summary> <details><summary>Colors</summary>
FTXUI support every color palettes: FTXUI support every color palette:
Color [gallery](https://arthursonzogni.github.io/FTXUI/examples_2dom_2color_gallery_8cpp-example.html): Color [gallery](https://arthursonzogni.github.io/FTXUI/examples_2dom_2color_gallery_8cpp-example.html):
![image](https://user-images.githubusercontent.com/4759106/147248595-04c7245a-5b85-4544-809d-a5984fc6f9e7.png) ![image](https://user-images.githubusercontent.com/4759106/147248595-04c7245a-5b85-4544-809d-a5984fc6f9e7.png)
@ -156,7 +156,7 @@ auto document = vbox({
A simple piece of text is represented using `text("content")`. A simple piece of text is represented using `text("content")`.
To support text wrapping following spaces the following function are provided: To support text wrapping following spaces the following functions are provided:
```cpp ```cpp
Element paragraph(std::string text); Element paragraph(std::string text);
Element paragraphAlignLeft(std::string text); Element paragraphAlignLeft(std::string text);
@ -321,8 +321,8 @@ Feel free to add your projects here:
## External package ## External package
It is **highly** recommanded to use cmake FetchContent to depends on FTXUI. This It is **highly** recommended to use CMake FetchContent to depend on FTXUI. This
way you can specify which commit you would like to depends on. way you can specify which commit you would like to depend on.
```cmake ```cmake
include(FetchContent) include(FetchContent)