FTXUI/README.md

78 lines
2.3 KiB
Markdown
Raw Normal View History

2019-01-06 08:37:26 +08:00
# 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)
2019-01-07 02:21:30 +08:00
## Build using CMake
~~~bash
mkdir build
cd build
cmake ..
make
sudo make install
~~~
## Use library using CMake
CMakeLists.txt
~~~cmake
cmake_minimum_required(VERSION 3.0)
find_package(ftxui REQUIRED)
add_executable(main main.cpp)
target_link_libraries(main PUBLIC ftxui::dom)
~~~
main.cpp
~~~cpp
#include "ftxui/screen/screen.hpp"
#include "ftxui/dom/elements.hpp"
#include <iostream>
int main(int argc, const char *argv[])
{
using namespace ftxui::screen;
using namespace ftxui::dom;
auto document =
hbox(
text(L"left") | bold,
text(L"middle") | flex,
text(L"right")
),
auto screen = Screen::TerminalOutput(document);
Render(screen, document.get());
std::cout << screen.ToString();
return 0;
}
~~~