From 9dbc23a7d49e1dbae45043122083d56a4ff903e6 Mon Sep 17 00:00:00 2001
From: IsakTheHacker <67378443+IsakTheHacker@users.noreply.github.com>
Date: Tue, 1 Mar 2022 19:07:50 +0100
Subject: [PATCH] Fix typos in README (#349)
---
README.md | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 5f6f8bd..d5e6687 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@
Documentation ·
- Report Bug ·
+ Report a Bug ·
Examples .
Request Feature ·
Send a Pull Request
@@ -22,21 +22,21 @@
Functional Terminal (X) User interface
-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:
![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.
Colors
-FTXUI support every color palettes:
+FTXUI support every color palette:
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)
@@ -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)