diff --git a/README.md b/README.md index 981d03a..1560278 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,29 @@ -# FTXUI +

+ Demo image +
+ + + + + + + + +
+ Documentation · + Report Bug · + Examples . + Request Feature · + Send a Pull Request -![C++][badge.cpp] -[![issues][badge.issues]][issues] -[![license][badge.license]][license] -[![contributors][badge.contributors]][contributors] +

-[badge.issues]: https://img.shields.io/github/issues-raw/arthursonzogni/FTXUI -[badge.license]: https://img.shields.io/github/license/arthursonzogni/FTXUI?color=black -[badge.contributors]: https://img.shields.io/github/contributors/arthursonzogni/FTXUI?color=blue -[badge.cpp]: https://img.shields.io/badge/c++-%2300599C.svg?style=flat&logo=c%2B%2B&logoColor=white +## FTXUI -[issues]: https://github.com/ArthurSonzogni/FTXUI/issues -[license]: http://opensource.org/licenses/MIT -[contributors]: https://github.com/ArthurSonzogni/FTXUI/graphs/contributors - -**Functional Terminal (X) User interface** +Functional Terminal (X) User interface A simple C++ library for terminal based user interface. -## Demo: -![Demo image](./examples/component/homescreen.gif) - ## Feature * Functional style. Inspired by [[1]](https://hackernoon.com/building-reactive-terminal-interfaces-in-c-d392ce34e649?gi=d9fb9ce35901) @@ -50,7 +53,7 @@ A simple C++ library for terminal based user interface. [link.windows-msvc]: https://github.com/ArthurSonzogni/FTXUI/actions/workflows/windows-msvc.yaml [link.mac-clang]: https://github.com/ArthurSonzogni/FTXUI/actions/workflows/mac-clang.yaml -## Example: +## Example ~~~cpp vbox({ hbox({ @@ -71,7 +74,7 @@ A simple C++ library for terminal based user interface. └────────────────────────────────────────────────────────────────────────────┘ ~~~ -# Documentation: +# Documentation - [Starter example project](https://github.com/ArthurSonzogni/ftxui-starter) - [Documentation](https://arthursonzogni.github.io/FTXUI/) @@ -96,11 +99,11 @@ Feel free to add your projects here: - [todoman](https://github.com/aaleino/todoman) - [TimeAccumulator](https://github.com/asari555/TimeAccumulator) -## Hosted on: +## Hosted on * [github](https://github.com/ArthurSonzogni/ftxui) * [gitlab](https://gitlab.com/ArthurSonzogni/ftxui) -## External package: +## 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.