diff --git a/README.md b/README.md index 5f6f8bdd10ee52938dbc2573fa7533c5e3f5b79a..d5e66875bd0e176db5a70adcb4fbd84f0ba72827 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ <br/> <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://github.com/ArthurSonzogni/FTXUI/issues">Request Feature</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> -A simple C++ library for terminal based user interface. +A simple C++ library for terminal based user interfaces! ## Feature * Functional style. Inspired by [[1]](https://hackernoon.com/building-reactive-terminal-interfaces-in-c-d392ce34e649?gi=d9fb9ce35901) and [React](https://reactjs.org/) - * 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) (→ 测试). - * No dependencies. - * Cross platform. Linux/mac (main target), Windows (experimental thanks to contributors), WebAssembly. - * Keyboard & mouse navigation. + * 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) (→ 测试) + * No dependencies + * Cross platform. Linux/MacOS (main target), Windows (experimental thanks to contributors), WebAssembly + * Keyboard & mouse navigation ## Operating systems -- Webassembly +- WebAssembly - Linux - MacOS - Windows @@ -120,13 +120,13 @@ An element can be decorated using the functions:  -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><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):  @@ -156,7 +156,7 @@ auto document = vbox({ 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 Element paragraph(std::string text); Element paragraphAlignLeft(std::string text); @@ -321,8 +321,8 @@ Feel free to add your projects here: ## External package -It is **highly** recommanded to use cmake FetchContent to depends on FTXUI. This -way you can specify which commit you would like to depends on. +It is **highly** recommended to use CMake FetchContent to depend on FTXUI. This +way you can specify which commit you would like to depend on. ```cmake include(FetchContent)