Skip to content

Commit 6dfd5ba

Browse files
committed
docs: Update README.md to clarify FTXUI dependency installation instructions
1 parent c4e6726 commit 6dfd5ba

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,7 @@ Based on the `examples/main.cpp` and the current codebase, the following core co
4141

4242
* **C++17 Compiler**: A compiler that supports C++17 (e.g., GCC, Clang, MSVC).
4343
* **CMake**: Version 3.15 or higher.
44-
* **FTXUI**: This project uses FTXUI as a dependency. You need to clone it into the `external/` directory:
45-
```bash
46-
git clone https://github.com/ArthurSonzogni/FTXUI.git external/ftxui
47-
```
44+
* **FTXUI**: This project uses FTXUI as a dependency.
4845

4946
### Building the Project
5047

@@ -53,15 +50,25 @@ Based on the `examples/main.cpp` and the current codebase, the following core co
5350
git clone https://github.com/skhelladi/TUIKit.git
5451
cd TUIKit
5552
```
53+
2. **Install dependencies:**
54+
- Install FTXUI:
55+
You need to clone it into the `external/ftxui` directory:
56+
```bash
57+
git clone https://github.com/ArthurSonzogni/FTXUI.git external/ftxui
58+
```
59+
- Install nolman/json for JSON parsing into `external/json`:
60+
```bash
61+
wget https://github.com/nlohmann/json/releases/download/v3.12.0/json.hpp -P external/json
62+
```
5663

57-
2. **Create a build directory and configure CMake:**
64+
3. **Create a build directory and configure CMake:**
5865
```bash
5966
mkdir build
6067
cd build
6168
cmake ..
6269
```
6370

64-
3. **Build the project:**
71+
4. **Build the project:**
6572
```bash
6673
cmake --build .
6774
```

0 commit comments

Comments
 (0)