Skip to content

Commit

Permalink
[Docs] Updated README to show docs website
Browse files Browse the repository at this point in the history
Signed-off-by: Vedant <[email protected]>
  • Loading branch information
vrnimje committed Oct 1, 2023
1 parent 71fb44b commit 5aaaf10
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
cmake_minimum_required(VERSION 3.14)
project(quick-ftxui
LANGUAGES CXX
VERSION 0.1.0
VERSION 0.2.0
)

set(CMAKE_CXX_STANDARD_REQUIRED 17)
Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ https://github.com/vrnimje/quick-ftxui/assets/103848930/715c821b-b259-4e2b-ab25-

**Note:** To run this example, build this repository with examples, steps [given here](#build-with-examples)

Check out the documentation for learning more about the language: [vrnimje.github.io/quick-ftxui/](https://vrnimje.github.io/quick-ftxui/)

## Build instructions:
~~~bash
mkdir build
Expand All @@ -244,13 +246,6 @@ ninja
./cpp_examples/quick_ftxui_example
~~~

## Roadmap for v0.2 release

- [x] Adding color (component wise)
- [x] Adding FTXUI DOM elements (like seperator, border)
- [x] Adding a way to use C++ defined variables directly, instead of depending on script-variables
- [ ] Adding detailed user documentation

## Dependencies

* [FTXUI](https://github.com/ArthurSonzogni/FTXUI), by [Arthur Sonzogni](https://github.com/ArthurSonzogni), for rendering the terminal graphics in backend
Expand Down

0 comments on commit 5aaaf10

Please sign in to comment.