Update tutorial.md and readme.md

2025-09-22 04:38:09 +08:00 · 2019-01-06 01:37:26 +01:00
parent 0b8a2ec181
commit c854d07d63
2 changed files with 65 additions and 10 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,33 @@
+# FTXUI
+
+A C++ library for making text based user interface.
+
+## Feature
+ * Functional style.
+ * Simple and elegant syntax (in my opinion).
+ * No dependencies.
+
+## Example:
+~~~cpp
+  vbox(
+    hbox(
+      text(L"left") | frame,
+      text(L"middle") | frame | flex,
+      text(L"right") | frame
+    ),
+    gauge(0.5) | frame
+  )
+~~~
+
+~~~bash
+┌────┐┌───────────────────────────────────────────────────────────────┐┌─────┐
+│left││middle                                                         ││right│
+└────┘└───────────────────────────────────────────────────────────────┘└─────┘
+┌────────────────────────────────────────────────────────────────────────────┐
+│██████████████████████████████████████                                      │
+└────────────────────────────────────────────────────────────────────────────┘
+~~~
+
+## Tutorial
+See [Tutorial](./tutorial.md)
+