zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-06-24 16:21:12 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Include additional information on module organisation

Browse Source
This commit is contained in:
Toyosatomimi no Miko 2025-06-02 10:57:45 -04:00
parent 9577dfc0b3
commit f1dfc8f2f8
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/cpp-modules.md
View File

@ -7,8 +7,7 @@
> please open an issue.
FTXUI provides an experimental support for [C++20
modules](https://en.cppreference.com/w/cpp/language/modules) to improve
compilation times and code organization.
modules](https://en.cppreference.com/w/cpp/language/modules) to improve compilation times and code organization. The existing API has a module corresponding to each header.
**Example with CMake and Ninja**
@ -40,8 +39,7 @@ ninja
### Module list
The modules directly reference the corresponding header, or a group of related
headers to provide a more convenient interface. The following modules
are available:
headers to provide a more convenient interface. The following modules are available:
- `ftxui`
- `ftxui.component`
@ -81,6 +79,10 @@ are available:
- `ftxui.util.AutoReset`
- `ftxui.util.Ref`
> ![NOTE]
> The module `ftxui` transitively imports all `ftxui.*` modules and thus
> has a dependency on those modules.
> ![NOTE] The list can be generated with the following command:
> ```sh
> git grep "export module" | cut -d: -f2 | cut -d\ -f3